List of all members | Public Member Functions | Protected Member Functions
ProviderSegment Class Reference

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

+ Inheritance diagram for ProviderSegment:

Public Member Functions

std::shared_ptr< Entity > findEntity (const std::string &entityName) const override
 find entity segment More...
 
bool forEachEntity (std::function< void(Entity &)> func) const override
 iterate over all core segments of this ltm More...
 
bool hasEntity (const std::string &entityName) const override
 check if entity segment exists More...
 
 ProviderSegment (const std::string &exportName, const MemoryID &memoryId, const std::shared_ptr< Processors > &filters, const std::shared_ptr< persistence::MemoryPersistenceStrategy > &persistenceStrategy)
 
- Public Member Functions inherited from ProviderSegmentBase< Entity >
aron::type::ObjectPtr aronType () const
 get aron type More...
 
Statistics getStatistics () const
 
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
 

Protected Member Functions

void _loadAllReferences (armem::wm::ProviderSegment &wmProviderSegment) override
 
void _loadLatestNReferences (int n, armem::wm::ProviderSegment &wmProviderSegment) override
 
void _resolve (armem::wm::ProviderSegment &wmProviderSegment) override
 
void _store (const armem::wm::ProviderSegment &wmProviderSegment, bool simulatedVersion) override
 
- Protected Member Functions inherited from MemoryItem
virtual void _setExportName (const std::string &)
 
virtual void _setMemoryID (const MemoryID &)
 

Additional Inherited Members

- Public Types inherited from ProviderSegmentBase< Entity >
using EntityT = Entity
 
- Static Public Member Functions inherited from ProviderSegmentBase< Entity >
static std::string getLevelName ()
 
- Protected Attributes inherited from ProviderSegmentBase< Entity >
std::recursive_mutex ltm_mutex
 
Statistics statistics
 
- Protected Attributes inherited from MemoryItem
std::shared_ptr< Processors > processors
 

Detailed Description

Definition at line 11 of file ProviderSegment.h.

Constructor & Destructor Documentation

◆ ProviderSegment()

ProviderSegment ( const std::string &  exportName,
const MemoryID &  memoryId,
const std::shared_ptr< Processors > &  filters,
const std::shared_ptr< persistence::MemoryPersistenceStrategy > &  persistenceStrategy 
)

Definition at line 14 of file ProviderSegment.cpp.

Member Function Documentation

◆ _loadAllReferences()

void _loadAllReferences ( armem::wm::ProviderSegment &  wmProviderSegment)
overrideprotectedvirtual

Implements ProviderSegmentBase< Entity >.

Definition at line 79 of file ProviderSegment.cpp.

+ Here is the call graph for this function:

◆ _loadLatestNReferences()

void _loadLatestNReferences ( int  n,
armem::wm::ProviderSegment &  wmProviderSegment 
)
overrideprotectedvirtual

Implements ProviderSegmentBase< Entity >.

Definition at line 118 of file ProviderSegment.cpp.

+ Here is the call graph for this function:

◆ _resolve()

void _resolve ( armem::wm::ProviderSegment &  wmProviderSegment)
overrideprotectedvirtual

Implements ProviderSegmentBase< Entity >.

Definition at line 158 of file ProviderSegment.cpp.

+ Here is the call graph for this function:

◆ _store()

void _store ( const armem::wm::ProviderSegment &  wmProviderSegment,
bool  simulatedVersion 
)
overrideprotectedvirtual

Implements ProviderSegmentBase< Entity >.

Definition at line 180 of file ProviderSegment.cpp.

+ Here is the call graph for this function:

◆ findEntity()

std::shared_ptr< Entity > findEntity ( const std::string &  ) const
overridevirtual

find entity segment

Implements ProviderSegmentBase< Entity >.

Definition at line 61 of file ProviderSegment.cpp.

+ Here is the call graph for this function:

◆ forEachEntity()

bool forEachEntity ( std::function< void(Entity &)>  func) const
overridevirtual

iterate over all core segments of this ltm

Implements ProviderSegmentBase< Entity >.

Definition at line 25 of file ProviderSegment.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ hasEntity()

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

check if entity segment exists

Implements ProviderSegmentBase< Entity >.

Definition at line 51 of file ProviderSegment.cpp.

+ Here is the caller graph for this function:
The documentation for this class was generated from the following files: