tf2::TimeCacheInterface Class Reference

#include <time_cache.hpp>

Inheritance diagram for tf2::TimeCacheInterface:

Public Member Functions
virtual	~TimeCacheInterface ()=default
virtual bool	getData (tf2::TimePoint time, tf2::TransformStorage &data_out, std::string *error_str=0, TF2Error *error_code=0)=0
	Access data from the cache returns false if data unavailable (should be thrown as lookup exception).
virtual bool	insertData (const tf2::TransformStorage &new_data)=0
	Insert data into the cache.
virtual void	clearList ()=0
	Clear the list of stored values.
virtual CompactFrameID	getParent (tf2::TimePoint time, std::string *error_str=0, TF2Error *error_code=0)=0
	Retrieve the parent at a specific time.
virtual P_TimeAndFrameID	getLatestTimeAndParent ()=0
	Get the latest time stored in this cache, and the parent associated with it. Returns parent = 0 if no data.
virtual unsigned int	getListLength ()=0
	Debugging information methods.
virtual tf2::TimePoint	getLatestTimestamp ()=0
	Get the latest timestamp cached.
virtual tf2::TimePoint	getOldestTimestamp ()=0
	Get the oldest timestamp cached.

Constructor & Destructor Documentation

~TimeCacheInterface()

virtual tf2::TimeCacheInterface::~TimeCacheInterface ( )

virtualdefault

Member Function Documentation

getData()

virtual bool tf2::TimeCacheInterface::getData ( tf2::TimePoint time, tf2::TransformStorage & data_out, std::string * error_str = 0, TF2Error * error_code = 0 )

pure virtual

Access data from the cache returns false if data unavailable (should be thrown as lookup exception).

Implemented in tf2::StaticCache, and tf2::TimeCache.

insertData()

virtual bool tf2::TimeCacheInterface::insertData ( const tf2::TransformStorage & new_data )

pure virtual

Insert data into the cache.

Implemented in tf2::StaticCache, and tf2::TimeCache.

clearList()

virtual void tf2::TimeCacheInterface::clearList ( )

pure virtual

Clear the list of stored values.

Implemented in tf2::StaticCache, and tf2::TimeCache.

getParent()

virtual CompactFrameID tf2::TimeCacheInterface::getParent ( tf2::TimePoint time, std::string * error_str = 0, TF2Error * error_code = 0 )

pure virtual

Retrieve the parent at a specific time.

Implemented in tf2::StaticCache, and tf2::TimeCache.

getLatestTimeAndParent()

virtual P_TimeAndFrameID tf2::TimeCacheInterface::getLatestTimeAndParent ( )

pure virtual

Get the latest time stored in this cache, and the parent associated with it. Returns parent = 0 if no data.

Implemented in tf2::StaticCache, and tf2::TimeCache.

getListLength()

virtual unsigned int tf2::TimeCacheInterface::getListLength ( )

pure virtual

Debugging information methods.

Get the length of the stored list

Implemented in tf2::StaticCache, and tf2::TimeCache.

getLatestTimestamp()

virtual tf2::TimePoint tf2::TimeCacheInterface::getLatestTimestamp ( )

pure virtual

Get the latest timestamp cached.

Implemented in tf2::StaticCache, and tf2::TimeCache.

getOldestTimestamp()

virtual tf2::TimePoint tf2::TimeCacheInterface::getOldestTimestamp ( )

pure virtual

Get the oldest timestamp cached.

Implemented in tf2::StaticCache, and tf2::TimeCache.

---

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

• include/tf2/time_cache.hpp