fawkes::tf::StaticCache Class Reference

Transform cache for static transforms. More...

#include <>>

Inheritance diagram for fawkes::tf::StaticCache:

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

Additional Inherited Members
Public Types inherited from fawkes::tf::TimeCacheInterface
typedef std::list< TransformStorage >	L_TransformStorage
	List of stored transforms. More...

Detailed Description

Transform cache for static transforms.

Definition at line 141 of file time_cache.h.

Constructor & Destructor Documentation

StaticCache()

fawkes::tf::StaticCache::StaticCache

(

)

Constructor.

Definition at line 65 of file static_cache.cpp.

Referenced by clone().

~StaticCache()

fawkes::tf::StaticCache::~StaticCache ( )

virtual

Destructor .

Definition at line 70 of file static_cache.cpp.

Member Function Documentation

clear_list()

void fawkes::tf::StaticCache::clear_list ( )

virtual

Clear storage.

Implements fawkes::tf::TimeCacheInterface.

Definition at line 104 of file static_cache.cpp.

clone()

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

virtual

Create a copy of this time cache.

Parameters

look_back_until

Ignored for static caches

Returns

shared pointer to copy of this time cache

Implements fawkes::tf::TimeCacheInterface.

Definition at line 79 of file static_cache.cpp.

References StaticCache().

get_data()

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

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

Implements fawkes::tf::TimeCacheInterface.

Definition at line 88 of file static_cache.cpp.

References fawkes::tf::TransformStorage::stamp.

get_latest_time_and_parent()

P_TimeAndFrameID fawkes::tf::StaticCache::get_latest_time_and_parent ( )

virtual

Get latest time and parent frame number.

Returns

latest time and parent frame number

Implements fawkes::tf::TimeCacheInterface.

Definition at line 122 of file static_cache.cpp.

References fawkes::tf::TransformStorage::frame_id.

get_latest_timestamp()

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

virtual

Get latest timestamp from cache.

Returns

latest timestamp

Implements fawkes::tf::TimeCacheInterface.

Definition at line 128 of file static_cache.cpp.

get_list_length()

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

virtual

Debugging information methods.

Get storage list length.

Returns

storage list length

Implements fawkes::tf::TimeCacheInterface.

Definition at line 110 of file static_cache.cpp.

get_oldest_timestamp()

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

virtual

Get oldest timestamp from cache.

Returns

oldest time stamp.

Implements fawkes::tf::TimeCacheInterface.

Definition at line 134 of file static_cache.cpp.

get_parent()

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

virtual

Get parent frame number.

Parameters

time	point in time
error_str	error string

Returns

frame number

Implements fawkes::tf::TimeCacheInterface.

Definition at line 116 of file static_cache.cpp.

References fawkes::tf::TransformStorage::frame_id.

get_storage()

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

virtual

Get storage list.

Returns

reference to list of storage elements

Implements fawkes::tf::TimeCacheInterface.

Definition at line 140 of file static_cache.cpp.

get_storage_copy()

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

virtual

Get copy of storage elements.

Returns

copied list of storage elements

Implements fawkes::tf::TimeCacheInterface.

Definition at line 146 of file static_cache.cpp.

insert_data()

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

virtual

Insert data.

Parameters

new_data

data to insert

Returns

true on success, false otherwise

Implements fawkes::tf::TimeCacheInterface.

Definition at line 96 of file static_cache.cpp.

---

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

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