tf2::TimeCache Class Reference

A class to keep a sorted linked list in time (newest first, oldest last). This builds and maintains a list of timestamped data. And provides lookup functions to get data out as a function of time. More...

#include <time_cache.hpp>

Inheritance diagram for tf2::TimeCache:

Collaboration diagram for tf2::TimeCache:

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

Protected Member Functions
const std::list< TransformStorage > &	getAllItems () const

Detailed Description

A class to keep a sorted linked list in time (newest first, oldest last). This builds and maintains a list of timestamped data. And provides lookup functions to get data out as a function of time.

Constructor & Destructor Documentation

TimeCache()

tf2::TimeCache::TimeCache ( tf2::Duration max_storage_time = TIMECACHE_DEFAULT_MAX_STORAGE_TIME )

explicit

Member Function Documentation

getData()

bool tf2::TimeCache::getData ( tf2::TimePoint time, tf2::TransformStorage & data_out, std::string * error_str = nullptr, TF2Error * error_code = nullptr )

overridevirtual

Overridden methods.

Implements tf2::TimeCacheInterface.

insertData()

bool tf2::TimeCache::insertData ( const tf2::TransformStorage & new_data )

overridevirtual

Insert data into the cache.

Implements tf2::TimeCacheInterface.

clearList()

void tf2::TimeCache::clearList ( )

overridevirtual

Clear the list of stored values.

Implements tf2::TimeCacheInterface.

getParent()

tf2::CompactFrameID tf2::TimeCache::getParent ( tf2::TimePoint time, std::string * error_str = nullptr, TF2Error * error_code = nullptr )

overridevirtual

Retrieve the parent at a specific time.

Implements tf2::TimeCacheInterface.

getLatestTimeAndParent()

P_TimeAndFrameID tf2::TimeCache::getLatestTimeAndParent ( )

overridevirtual

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

Implements tf2::TimeCacheInterface.

getListLength()

unsigned int tf2::TimeCache::getListLength ( )

overridevirtual

Debugging information methods.

Implements tf2::TimeCacheInterface.

getLatestTimestamp()

TimePoint tf2::TimeCache::getLatestTimestamp ( )

overridevirtual

Get the latest timestamp cached.

Implements tf2::TimeCacheInterface.

getOldestTimestamp()

TimePoint tf2::TimeCache::getOldestTimestamp ( )

overridevirtual

Get the oldest timestamp cached.

Implements tf2::TimeCacheInterface.

getAllItems()

const std::list< TransformStorage > & tf2::TimeCache::getAllItems ( ) const

protected

---

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

• include/tf2/time_cache.hpp