fawkes::tf::TimeCacheInterface Class Reference

Interface for transform time caches. More...

#include <>>

Inheritance diagram for fawkes::tf::TimeCacheInterface:

Public Types
typedef std::list< TransformStorage >	L_TransformStorage
	List of stored transforms. More...

Public Member Functions
virtual TimeCacheInterfacePtr	clone (const fawkes::Time &look_back_until=fawkes::Time(0, 0)) const =0
	Create a copy of this time cache. More...
virtual bool	get_data (fawkes::Time time, TransformStorage &data_out, std::string *error_str=0)=0
	Get data. More...
virtual bool	insert_data (const TransformStorage &new_data)=0
	Insert data. More...
virtual void	clear_list ()=0
	Clear storage. More...
virtual CompactFrameID	get_parent (fawkes::Time time, std::string *error_str)=0
	Get parent frame number. More...
virtual P_TimeAndFrameID	get_latest_time_and_parent ()=0
	Get latest time and parent frame number. More...
virtual unsigned int	get_list_length () const =0
	Debugging information methods. More...
virtual fawkes::Time	get_latest_timestamp () const =0
	Get latest timestamp from cache. More...
virtual fawkes::Time	get_oldest_timestamp () const =0
	Get oldest timestamp from cache. More...
virtual const L_TransformStorage &	get_storage () const =0
	Get storage list. More...
virtual L_TransformStorage	get_storage_copy () const =0
	Get copy of storage elements. More...

Detailed Description

Interface for transform time caches.

Definition at line 70 of file time_cache.h.

Member Typedef Documentation

L_TransformStorage

typedef std::list<TransformStorage> fawkes::tf::TimeCacheInterface::L_TransformStorage

List of stored transforms.

Definition at line 74 of file time_cache.h.

Member Function Documentation

clear_list()

void fawkes::tf::TimeCacheInterface::clear_list ( )

pure virtual

Clear storage.

Implemented in fawkes::tf::StaticCache, and fawkes::tf::TimeCache.

clone()

TimeCacheInterfacePtr fawkes::tf::TimeCacheInterface::clone ( const fawkes::Time &  look_back_until = fawkes::Time(0, 0) ) const

pure virtual

Create a copy of this time cache.

Parameters

look_back_until

if non-zero time is passed only include transforms younger than the given time.

Returns

shared pointer to copy of this time cache

Implemented in fawkes::tf::StaticCache, and fawkes::tf::TimeCache.

get_data()

bool fawkes::tf::TimeCacheInterface::get_data ( fawkes::Time  time, TransformStorage &  data_out, std::string *  error_str = 0  )

pure virtual

Get data.

Parameters

time	time for which go get data
data_out	upon return contains requested data
error_str	error stirng

Returns

false if data not available

Implemented in fawkes::tf::StaticCache, and fawkes::tf::TimeCache.

get_latest_time_and_parent()

P_TimeAndFrameID fawkes::tf::TimeCacheInterface::get_latest_time_and_parent ( )

pure virtual

Get latest time and parent frame number.

Returns

latest time and parent frame number

Implemented in fawkes::tf::StaticCache, and fawkes::tf::TimeCache.

get_latest_timestamp()

fawkes::Time fawkes::tf::TimeCacheInterface::get_latest_timestamp ( ) const

pure virtual

Get latest timestamp from cache.

Returns

latest timestamp

Implemented in fawkes::tf::StaticCache, and fawkes::tf::TimeCache.

get_list_length()

unsigned int fawkes::tf::TimeCacheInterface::get_list_length ( ) const

pure virtual

Debugging information methods.

Get storage list length.

Returns

storage list length

Implemented in fawkes::tf::StaticCache, and fawkes::tf::TimeCache.

get_oldest_timestamp()

fawkes::Time fawkes::tf::TimeCacheInterface::get_oldest_timestamp ( ) const

pure virtual

Get oldest timestamp from cache.

Returns

oldest time stamp.

Implemented in fawkes::tf::StaticCache, and fawkes::tf::TimeCache.

get_parent()

CompactFrameID fawkes::tf::TimeCacheInterface::get_parent ( fawkes::Time  time, std::string *  error_str  )

pure virtual

Get parent frame number.

Parameters

time	point in time
error_str	error string

Returns

frame number

Implemented in fawkes::tf::StaticCache, and fawkes::tf::TimeCache.

get_storage()

const L_TransformStorage & fawkes::tf::TimeCacheInterface::get_storage ( ) const

pure virtual

Get storage list.

Returns

reference to list of storage elements

Implemented in fawkes::tf::StaticCache, and fawkes::tf::TimeCache.

get_storage_copy()

L_TransformStorage fawkes::tf::TimeCacheInterface::get_storage_copy ( ) const

pure virtual

Get copy of storage elements.

Returns

copied list of storage elements

Implemented in fawkes::tf::StaticCache, and fawkes::tf::TimeCache.

insert_data()

bool fawkes::tf::TimeCacheInterface::insert_data ( const TransformStorage &  new_data )

pure virtual

Insert data.

Parameters

new_data

data to insert

Returns

true on success, false otherwise

Implemented in fawkes::tf::StaticCache, and fawkes::tf::TimeCache.

---

The documentation for this class was generated from the following files:

• src/libs/tf/time_cache.h
• src/libs/tf/time_cache.cpp