List of all members | Public Member Functions
WorkingMemorySnapshot Class Reference

The WorkingMemorySnapshot class handles snapshot IO methods. More...

#include <MemoryX/libraries/longtermmemory/WorkingMemorySnapshot.h>

+ Inheritance diagram for WorkingMemorySnapshot:

Public Member Functions

PersistentEntitySegmentBasePrx addSegment (const ::std::string &segName, const ::Ice::Current &=Ice::emptyCurrent) override
 
void clear (const ::Ice::Current &=Ice::emptyCurrent) override
 
void deserialize (const armarx::ObjectSerializerBasePtr &serializer, const ::Ice::Current &=Ice::emptyCurrent) override
 
Ice::Identity getIceId () const
 
PersistentEntitySegmentBasePrx getSegment (const ::std::string &segName, const ::Ice::Current &=Ice::emptyCurrent) override
 
SegmentMap getSegmentAndCollectionNames () const
 
NameList getSegmentNames (const ::Ice::Current &=Ice::emptyCurrent) override
 
bool hasSegment (const ::std::string &segName, const ::Ice::Current &=Ice::emptyCurrent) override
 
void restoreWorkingMemory (const AbstractWorkingMemoryInterfacePrx &workingMemory, const ::Ice::Current &=Ice::emptyCurrent) override
 Restore all segments with all entities of this snapshot to the WorkingMemory. More...
 
void saveWorkingMemory (const AbstractWorkingMemoryInterfacePrx &workingMemory, const ::Ice::Current &=Ice::emptyCurrent) override
 Save all segments with all entities of the WorkingMemory to this snapshot. More...
 
void saveWorkingMemorySubset (const AbstractWorkingMemoryInterfacePrx &workingMemory, const Ice::StringSeq &entityIdList, const ::Ice::Current &=Ice::emptyCurrent) override
 
void serialize (const armarx::ObjectSerializerBasePtr &serializer, const ::Ice::Current &=Ice::emptyCurrent) const override
 
 WorkingMemorySnapshot (const std::string &name, Ice::CommunicatorPtr ic, const DatabaseInterfacePrx &databasePrx)
 

Detailed Description

The WorkingMemorySnapshot class handles snapshot IO methods.

Snapshots can be loaded and restored from the database.

Definition at line 42 of file WorkingMemorySnapshot.h.

Constructor & Destructor Documentation

◆ WorkingMemorySnapshot()

WorkingMemorySnapshot ( const std::string &  name,
Ice::CommunicatorPtr  ic,
const DatabaseInterfacePrx &  databasePrx 
)

Definition at line 37 of file WorkingMemorySnapshot.cpp.

Member Function Documentation

◆ addSegment()

PersistentEntitySegmentBasePrx addSegment ( const ::std::string &  segName,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 44 of file WorkingMemorySnapshot.cpp.

+ Here is the call graph for this function:

◆ clear()

void clear ( const ::Ice::Current &  = Ice::emptyCurrent)
override

Definition at line 125 of file WorkingMemorySnapshot.cpp.

◆ deserialize()

void deserialize ( const armarx::ObjectSerializerBasePtr &  serializer,
const ::Ice::Current &  c = Ice::emptyCurrent 
)
override

Definition at line 259 of file WorkingMemorySnapshot.cpp.

◆ getIceId()

Ice::Identity getIceId ( ) const

Definition at line 232 of file WorkingMemorySnapshot.cpp.

◆ getSegment()

PersistentEntitySegmentBasePrx getSegment ( const ::std::string &  segName,
const ::Ice::Current &  c = Ice::emptyCurrent 
)
override

Definition at line 61 of file WorkingMemorySnapshot.cpp.

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

◆ getSegmentAndCollectionNames()

SegmentMap getSegmentAndCollectionNames ( ) const

Definition at line 135 of file WorkingMemorySnapshot.cpp.

◆ getSegmentNames()

NameList getSegmentNames ( const ::Ice::Current &  = Ice::emptyCurrent)
override

Definition at line 113 of file WorkingMemorySnapshot.cpp.

◆ hasSegment()

bool hasSegment ( const ::std::string &  segName,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 108 of file WorkingMemorySnapshot.cpp.

◆ restoreWorkingMemory()

void restoreWorkingMemory ( const AbstractWorkingMemoryInterfacePrx &  workingMemory,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Restore all segments with all entities of this snapshot to the WorkingMemory.

Parameters
workingMemoryThe WorkingMemory to restore.

Definition at line 194 of file WorkingMemorySnapshot.cpp.

◆ saveWorkingMemory()

void saveWorkingMemory ( const AbstractWorkingMemoryInterfacePrx &  workingMemory,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Save all segments with all entities of the WorkingMemory to this snapshot.

Parameters
workingMemoryThe WorkingMemory to save.

Definition at line 140 of file WorkingMemorySnapshot.cpp.

◆ saveWorkingMemorySubset()

void saveWorkingMemorySubset ( const AbstractWorkingMemoryInterfacePrx &  workingMemory,
const Ice::StringSeq &  entityIdList,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 161 of file WorkingMemorySnapshot.cpp.

◆ serialize()

void serialize ( const armarx::ObjectSerializerBasePtr &  serializer,
const ::Ice::Current &  c = Ice::emptyCurrent 
) const
override

Definition at line 243 of file WorkingMemorySnapshot.cpp.

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