ProviderSegment Class Reference

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

+ Inheritance diagram for ProviderSegment:

Public Member Functions

 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
 
std::shared_ptr< EntityTfindEntity (const std::string &entityName) const
 find entity segment
 
bool forEachEntity (std::function< void(EntityT &)> func) const
 iterate over all core segments of this ltm
 
Statistics getStatistics () const
 
bool hasEntity (const std::string &entityName) const
 check if entity segment exists
 
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
 
void loadLatestNReferences (int n, armem::wm::ProviderSegment &provSeg)
 
 MemoryItem (const std::string &exportName, const MemoryID &)
 
 MemoryItem (const std::string &exportName, const MemoryID &)
 
 MemoryItem (const std::string &exportName, const MemoryID &, const std::shared_ptr< Processors > &)
 
 MemoryItem (const std::string &exportName, const MemoryID &, const std::shared_ptr< Processors > &)
 
void resetStatistics ()
 statistics
 
void resolve (armem::wm::ProviderSegment &provSeg)
 convert the references of the input into a wm::Memory
 
void store (const armem::wm::ProviderSegment &provSeg, 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
 

Protected Member Functions

std::shared_ptr< Entity_implFindEntity (const std::string &entityName) const override
 
bool _implForEachEntity (std::function< void(Entity &)> func) const override
 
bool _implHasEntity (const std::string &entityName) const override
 
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
 
- Static Public Member Functions inherited from ProviderSegmentBase< Entity >
static std::string getLevelName ()
 
- Protected Attributes inherited from ProviderSegmentBase< Entity >
Statistics statistics
 
- Protected Attributes inherited from MemoryItem
std::shared_ptr< Processorsprocessors
 

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 15 of file ProviderSegment.cpp.

Member Function Documentation

◆ _implFindEntity()

std::shared_ptr< Entity > _implFindEntity ( const std::string & entityName) const
overrideprotectedvirtual

Implements ProviderSegmentBase< Entity >.

Definition at line 60 of file ProviderSegment.cpp.

+ Here is the call graph for this function:

◆ _implForEachEntity()

bool _implForEachEntity ( std::function< void(Entity &)> func) const
overrideprotectedvirtual

Implements ProviderSegmentBase< Entity >.

Definition at line 27 of file ProviderSegment.cpp.

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

◆ _implHasEntity()

bool _implHasEntity ( const std::string & entityName) const
overrideprotectedvirtual

Implements ProviderSegmentBase< Entity >.

Definition at line 52 of file ProviderSegment.cpp.

+ Here is the caller graph for this function:

◆ _loadAllReferences()

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

Implements ProviderSegmentBase< Entity >.

Definition at line 74 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 122 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 172 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 193 of file ProviderSegment.cpp.

+ Here is the call graph for this function:

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