ProviderSegmentBase< _EntityT > Class Template Reference

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

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

Inheritance diagram for ProviderSegmentBase< _EntityT >:

Classes
struct	Statistics

Public Types
using	EntityT = _EntityT

Public Member Functions
aron::type::ObjectPtr	aronType () const
	get aron type More...
virtual std::shared_ptr< EntityT >	findEntity (const std::string &) const =0
	find entity segment More...
virtual bool	forEachEntity (std::function< void(EntityT &)> func) const =0
	iterate over all core segments of this ltm More...
Statistics	getStatistics () const
virtual bool	hasEntity (const std::string &) const =0
	check if entity segment exists More...
void	loadAllReferences (armem::wm::ProviderSegment &provSeg)
	return the full sub-ltm as a wm::ProviderSegment with only references the ltm may be huge, use with caution More...
void	loadLatestNReferences (int n, armem::wm::ProviderSegment &provSeg)
	MemoryItem (const std::string &exportName, const MemoryID &)
	MemoryItem (const std::string &exportName, const MemoryID &, const std::shared_ptr< Processors > &)
void	resetStatistics ()
	statistics More...
void	resolve (armem::wm::ProviderSegment &provSeg)
	convert the references of the input into a wm::Memory More...
void	store (const armem::wm::ProviderSegment &provSeg, bool simulatedVersion)
	encode the content of a wm::Memory and store More...
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 void	_loadAllReferences (armem::wm::ProviderSegment &)=0
virtual void	_loadLatestNReferences (int n, armem::wm::ProviderSegment &p)=0
virtual void	_resolve (armem::wm::ProviderSegment &)=0
virtual void	_store (const armem::wm::ProviderSegment &p, bool simulatedVersion=false)=0
Protected Member Functions inherited from MemoryItem
virtual void	_setExportName (const std::string &)
virtual void	_setMemoryID (const MemoryID &)

Protected Attributes
std::recursive_mutex	ltm_mutex
Statistics	statistics
Protected Attributes inherited from MemoryItem
std::shared_ptr< Processors >	processors

Detailed Description

template<class _EntityT>
class armarx::armem::server::ltm::detail::ProviderSegmentBase< _EntityT >

Interface functions for the longterm memory classes.

Definition at line 16 of file ProviderSegmentBase.h.

Member Typedef Documentation

EntityT

using EntityT = _EntityT

Definition at line 25 of file ProviderSegmentBase.h.

Member Function Documentation

_loadAllReferences()

virtual void _loadAllReferences ( armem::wm::ProviderSegment &  )

protectedpure virtual

Implemented in ProviderSegment.

Here is the caller graph for this function:

_loadLatestNReferences()

virtual void _loadLatestNReferences ( int  n, armem::wm::ProviderSegment &  p  )

protectedpure virtual

Implemented in ProviderSegment.

Here is the caller graph for this function:

_resolve()

virtual void _resolve ( armem::wm::ProviderSegment &  )

protectedpure virtual

Implemented in ProviderSegment.

Here is the caller graph for this function:

_store()

virtual void _store ( const armem::wm::ProviderSegment &  p, bool  simulatedVersion = false  )

protectedpure virtual

Implemented in ProviderSegment.

Here is the caller graph for this function:

aronType()

aron::type::ObjectPtr aronType ( ) const

inline

get aron type

Definition at line 81 of file ProviderSegmentBase.h.

findEntity()

virtual std::shared_ptr<EntityT> findEntity ( const std::string &  ) const

pure virtual

find entity segment

Implemented in ProviderSegment.

forEachEntity()

virtual bool forEachEntity ( std::function< void(EntityT &)>  func ) const

pure virtual

iterate over all core segments of this ltm

Implemented in ProviderSegment.

getLevelName()

static std::string getLevelName ( )

inlinestatic

Definition at line 87 of file ProviderSegmentBase.h.

getStatistics()

Statistics getStatistics ( ) const

inline

Definition at line 65 of file ProviderSegmentBase.h.

hasEntity()

virtual bool hasEntity ( const std::string &  ) const

pure virtual

check if entity segment exists

Implemented in ProviderSegment.

loadAllReferences()

void loadAllReferences ( armem::wm::ProviderSegment &  provSeg )

inline

return the full sub-ltm as a wm::ProviderSegment with only references the ltm may be huge, use with caution

Definition at line 32 of file ProviderSegmentBase.h.

loadLatestNReferences()

void loadLatestNReferences ( int  n, armem::wm::ProviderSegment &  provSeg  )

inline

Definition at line 38 of file ProviderSegmentBase.h.

MemoryItem() [1/2]

MemoryItem

Definition at line 10 of file MemoryItem.cpp.

MemoryItem() [2/2]

MemoryItem

Definition at line 15 of file MemoryItem.cpp.

resetStatistics()

void resetStatistics ( )

inline

statistics

Definition at line 59 of file ProviderSegmentBase.h.

resolve()

void resolve ( armem::wm::ProviderSegment &  provSeg )

inline

convert the references of the input into a wm::Memory

Definition at line 45 of file ProviderSegmentBase.h.

Here is the caller graph for this function:

store()

void store ( const armem::wm::ProviderSegment &  provSeg, bool  simulatedVersion  )

inline

encode the content of a wm::Memory and store

Definition at line 52 of file ProviderSegmentBase.h.

Here is the caller graph for this function:

Member Data Documentation

ltm_mutex

std::recursive_mutex ltm_mutex

mutableprotected

Definition at line 99 of file ProviderSegmentBase.h.

statistics

Statistics statistics

protected

Definition at line 101 of file ProviderSegmentBase.h.

---

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

• RobotAPI/libraries/armem/server/ltm/detail/ProviderSegmentBase.h