Loader Class Reference

Load LTMs into WM. More...

#include <RobotAPI/libraries/armem/client/Loader.h>

Public Member Functions

 Loader (const Loader &)=default
 Construct a memory reader.
 
 Loader (server::LoadingMemoryInterfacePrx loadingMemory=nullptr)
 
bool loadExportIntoWM (std::string export_path, std::string memoryName, std::vector< std::string > coreSegmentNames, bool addNonExistingCoreSegments, int amountOfSnapshotsPerSegmentToLoad)
 loads data from a specified LTM export into the currently running WM (needs to already have the CoreSegments)
 
void loadLTMintoWM (bool complete=true)
 Loads all entries of potential multiple ltms into the wm (i.e.
 
 operator bool () const
 
void setLoadingMemory (server::LoadingMemoryInterfacePrx configuringMemory)
 

Public Attributes

server::LoadingMemoryInterfacePrx loadingPrx
 

Detailed Description

Load LTMs into WM.

Constructor & Destructor Documentation

◆ Loader() [1/2]

Loader ( const Loader & )
default

Construct a memory reader.

Parameters
memoryThe memory proxy.

◆ Loader() [2/2]

Loader ( server::LoadingMemoryInterfacePrx loadingMemory = nullptr)
inline

Member Function Documentation

◆ loadExportIntoWM()

bool loadExportIntoWM ( std::string export_path,
std::string memoryName,
std::vector< std::string > coreSegmentNames,
bool addNonExistingCoreSegments,
int amountOfSnapshotsPerSegmentToLoad )

loads data from a specified LTM export into the currently running WM (needs to already have the CoreSegments)

This function loads an LTM specified by export_path and memoryName into the current WM. It handles if the path is not a correct LTM export. If you do this multiple times the LTM is always appended to the WM ,meaning you can load several LTM exports into the same WM. This does not exclude the maxHistory size from working! If you load to much snapshots they will still be discarded.

Parameters
export_pathpath to the export folder (needs to be a string with '/' as delimiter)
memoryNamename of the memory server (e.g. 'Object', 'Skill')
coreSegmentName(not yet supported)
addNonExistingCoreSegments(not yet supported)
amountOfSnapshotsPerSegmentToLoad(not yet supported)
Returns
bool true if everything worked fine, false if some error arose permitting the LTM to be loaded

◆ loadLTMintoWM()

void loadLTMintoWM ( bool complete = true)

Loads all entries of potential multiple ltms into the wm (i.e.

if a RedundantPersistenceStrategy is used with multiple strategies inside)

◆ operator bool()

operator bool ( ) const
inline

◆ setLoadingMemory()

void setLoadingMemory ( server::LoadingMemoryInterfacePrx configuringMemory)

Member Data Documentation

◆ loadingPrx

server::LoadingMemoryInterfacePrx loadingPrx

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