Interface functions for the longterm memory classes. More...

#include <RobotAPI/libraries/armem/server/ltm/detail/EntityBase.h>

Inheritance diagram for EntityBase< _EntitySnapshotT >:

Classes
struct	Statistics

Public Types
using	EntitySnapshotT = _EntitySnapshotT

Public Member Functions
std::shared_ptr< EntitySnapshotT >	findFirstSnapshotAfter (const Time &time) const

std::shared_ptr< EntitySnapshotT >	findFirstSnapshotAfterOrAt (const Time &time) const

std::shared_ptr< EntitySnapshotT >	findLatestSnapshot () const

std::shared_ptr< EntitySnapshotT >	findLatestSnapshotBefore (const Time &time) const

std::shared_ptr< EntitySnapshotT >	findLatestSnapshotBeforeOrAt (const Time &time) const

std::shared_ptr< EntitySnapshotT >	findSnapshot (const Time &time) const
	find entity snapshot segment

bool	forEachSnapshot (std::function< void(EntitySnapshotT &)> func) const
	iterate over all entity snapshots of this ltm

bool	forEachSnapshotBefore (const Time &time, std::function< void(EntitySnapshotT &)> func) const

bool	forEachSnapshotBeforeOrAt (const Time &time, std::function< void(EntitySnapshotT &)> func) const

bool	forEachSnapshotBeforeReverse (const Time &time, std::function< bool(EntitySnapshotT &)> func) const

bool	forEachSnapshotInIndexRange (long first, long last, std::function< void(EntitySnapshotT &)> func) const

bool	forEachSnapshotInTimeRange (const Time &min, const Time &max, std::function< void(EntitySnapshotT &)> func) const

Statistics	getStatistics () const

bool	hasSnapshot (const Time &time) const
	check if snapshot segment exists

void	loadAllReferences (armem::wm::Entity &e)
	return the full sub-ltm as a wm::Entity with only references the ltm may be huge, use with caution

void	loadLatestNReferences (int n, armem::wm::Entity &e)

	MemoryItem (const std::string &exportName, const MemoryID &)

	MemoryItem (const std::string &exportName, const MemoryID &, const std::shared_ptr< Processors > &)

void	resetStatistics ()
	statistics

void	resolve (armem::wm::Entity &e)
	convert the references of the input into a wm::Memory

void	store (const armem::wm::Entity &e, bool simulatedVersion)
	encode the content of a wm::Memory and store

Public Member Functions inherited from MemoryItem
virtual std::string	getExportName () const

MemoryID	getMemoryID () const

MemoryID	id () const

	MemoryItem (const std::string &exportName, const MemoryID &)

	MemoryItem (const std::string &exportName, const MemoryID &, const std::shared_ptr< Processors > &)

std::string	name () const

void	setExportName (const std::string &n)

void	setMemoryID (const MemoryID &)

void	setMemoryName (const std::string &memoryName)

virtual	~MemoryItem ()=default

Static Public Member Functions
static std::string	getLevelName ()

Protected Member Functions
virtual std::shared_ptr< EntitySnapshotT >	_implFindFirstSnapshotAfter (const Time &time) const =0

virtual std::shared_ptr< EntitySnapshotT >	_implFindFirstSnapshotAfterOrAt (const Time &time) const =0

virtual std::shared_ptr< EntitySnapshotT >	_implFindLatestSnapshot () const =0

virtual std::shared_ptr< EntitySnapshotT >	_implFindLatestSnapshotBefore (const Time &time) const =0

virtual std::shared_ptr< EntitySnapshotT >	_implFindLatestSnapshotBeforeOrAt (const Time &time) const =0

virtual std::shared_ptr< EntitySnapshotT >	_implFindSnapshot (const Time &) const =0

virtual bool	_implForEachSnapshot (std::function< void(EntitySnapshotT &)> func) const =0

virtual bool	_implForEachSnapshotBefore (const Time &time, std::function< void(EntitySnapshotT &)> func) const =0

virtual bool	_implForEachSnapshotBeforeOrAt (const Time &time, std::function< void(EntitySnapshotT &)> func) const =0

virtual bool	_implForEachSnapshotBeforeReverse (const Time &time, std::function< bool(EntitySnapshotT &)> func) const =0

virtual bool	_implForEachSnapshotInIndexRange (long first, long last, std::function< void(EntitySnapshotT &)> func) const =0

virtual bool	_implForEachSnapshotInTimeRange (const Time &min, const Time &max, std::function< void(EntitySnapshotT &)> func) const =0

virtual bool	_implHasSnapshot (const Time &) const =0

virtual void	_loadAllReferences (armem::wm::Entity &)=0

virtual void	_loadLatestNReferences (int n, armem::wm::Entity &e)=0

virtual void	_resolve (armem::wm::Entity &)=0

virtual void	_store (const armem::wm::Entity &e, bool simulatedVersion=false)=0

Protected Member Functions inherited from MemoryItem
virtual void	_setExportName (const std::string &)

virtual void	_setMemoryID (const MemoryID &)

Protected Attributes
Statistics	statistics

Protected Attributes inherited from MemoryItem
std::shared_ptr< Processors >	processors

Detailed Description

template<class _EntitySnapshotT>
class armarx::armem::server::ltm::detail::EntityBase< _EntitySnapshotT >

Interface functions for the longterm memory classes.