MemoryToIceAdapter Class Reference

Helps connecting a Memory server to the Ice interface. More...

#include <RobotAPI/libraries/armem/server/MemoryToIceAdapter.h>

Public Member Functions

data::AddSegmentResult addSegment (const data::AddSegmentInput &input, bool addCoreSegments=false)
 
data::AddSegmentsResult addSegments (const data::AddSegmentsInput &input, bool addCoreSegments=false)
 
armem::CommitResult commit (const armem::Commit &commit)
 
data::CommitResult commit (const data::Commit &commitIce)
 
data::CommitResult commit (const data::Commit &commitIce, Time timeArrived)
 
armem::CommitResult commitLocking (const armem::Commit &commit)
 
data::CommitResult commitLocking (const data::Commit &commitIce)
 
data::CommitResult commitLocking (const data::Commit &commitIce, Time timeArrived)
 
dto::DirectlyStoreResult directlyStore (const dto::DirectlyStoreInput &directlStoreInput)
 
prediction::data::EngineSupportMap getAvailableEngines ()
 
dto::RecordStatusResult getRecordStatus ()
 
armem::structure::data::GetServerStructureResult getServerStructure ()
 
 MemoryToIceAdapter (server::wm::Memory *workingMemory=nullptr, server::ltm::Memory *longtermMemory=nullptr)
 Construct an MemoryToIceAdapter from an existing Memory. More...
 
prediction::data::PredictionResultSeq predict (prediction::data::PredictionRequestSeq requests)
 
query::data::Result query (const armem::query::data::Input &input)
 
client::QueryResult query (const client::QueryInput &input)
 
query::data::Result queryLTM (const armem::query::data::Input &input, bool storeIntoWM)
 Query the LTMs of the memory server. More...
 
armem::CommitResult reloadAllFromLTM ()
 Loads all core segments and their data from the LTM. More...
 
armem::CommitResult reloadCoreSegmentsFromLTM (std::list< std::string > &coreSegmentname)
 Only load specific core segments and their data from the LTM. More...
 
armem::CommitResult reloadFromLTMOnStartup ()
 Triggers a reload (. More...
 
armem::CommitResult reloadPropertyDefinedCoreSegmentsFromLTM ()
 
void setMemoryListener (client::MemoryListenerInterfacePrx memoryListenerTopic)
 
dto::StartRecordResult startRecord (const dto::StartRecordInput &startRecordInput)
 
dto::StopRecordResult stopRecord ()
 

Public Attributes

server::ltm::MemorylongtermMemory
 
client::MemoryListenerInterfacePrx memoryListenerTopic
 
server::wm::MemoryworkingMemory
 

Detailed Description

Helps connecting a Memory server to the Ice interface.

This involves conversion of ice types to C++ types as well as catchin exceptions and converting them to error messages

Definition at line 19 of file MemoryToIceAdapter.h.

Constructor & Destructor Documentation

◆ MemoryToIceAdapter()

MemoryToIceAdapter ( server::wm::Memory workingMemory = nullptr,
server::ltm::Memory longtermMemory = nullptr 
)

Construct an MemoryToIceAdapter from an existing Memory.

Definition at line 29 of file MemoryToIceAdapter.cpp.

Member Function Documentation

◆ addSegment()

data::AddSegmentResult addSegment ( const data::AddSegmentInput &  input,
bool  addCoreSegments = false 
)

Definition at line 43 of file MemoryToIceAdapter.cpp.

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

◆ addSegments()

data::AddSegmentsResult addSegments ( const data::AddSegmentsInput &  input,
bool  addCoreSegments = false 
)

Definition at line 105 of file MemoryToIceAdapter.cpp.

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

◆ commit() [1/3]

armem::CommitResult commit ( const armem::Commit commit)

Definition at line 163 of file MemoryToIceAdapter.cpp.

+ Here is the call graph for this function:

◆ commit() [2/3]

data::CommitResult commit ( const data::Commit &  commitIce)

Definition at line 156 of file MemoryToIceAdapter.cpp.

+ Here is the call graph for this function:

◆ commit() [3/3]

data::CommitResult commit ( const data::Commit &  commitIce,
Time  timeArrived 
)

Definition at line 119 of file MemoryToIceAdapter.cpp.

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

◆ commitLocking() [1/3]

armem::CommitResult commitLocking ( const armem::Commit commit)

Definition at line 214 of file MemoryToIceAdapter.cpp.

+ Here is the call graph for this function:

◆ commitLocking() [2/3]

data::CommitResult commitLocking ( const data::Commit &  commitIce)

Definition at line 207 of file MemoryToIceAdapter.cpp.

+ Here is the call graph for this function:

◆ commitLocking() [3/3]

data::CommitResult commitLocking ( const data::Commit &  commitIce,
Time  timeArrived 
)

Definition at line 170 of file MemoryToIceAdapter.cpp.

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

◆ directlyStore()

dto::DirectlyStoreResult directlyStore ( const dto::DirectlyStoreInput &  directlStoreInput)

Definition at line 517 of file MemoryToIceAdapter.cpp.

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

◆ getAvailableEngines()

prediction::data::EngineSupportMap getAvailableEngines ( )

Definition at line 631 of file MemoryToIceAdapter.cpp.

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

◆ getRecordStatus()

dto::RecordStatusResult getRecordStatus ( )

Definition at line 588 of file MemoryToIceAdapter.cpp.

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

◆ getServerStructure()

armem::structure::data::GetServerStructureResult getServerStructure ( )

Definition at line 389 of file MemoryToIceAdapter.cpp.

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

◆ predict()

prediction::data::PredictionResultSeq predict ( prediction::data::PredictionRequestSeq  requests)

Definition at line 623 of file MemoryToIceAdapter.cpp.

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

◆ query() [1/2]

armem::query::data::Result query ( const armem::query::data::Input &  input)

Definition at line 319 of file MemoryToIceAdapter.cpp.

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

◆ query() [2/2]

client::QueryResult query ( const client::QueryInput input)

Definition at line 381 of file MemoryToIceAdapter.cpp.

+ Here is the call graph for this function:

◆ queryLTM()

armem::query::data::Result queryLTM ( const armem::query::data::Input &  input,
bool  storeIntoWM 
)

Query the LTMs of the memory server.

Stored into WM if recording mode is enabled.

Parameters
storeIntoWMif set the result is also stored into the wm, no matter the recording mode.

Definition at line 345 of file MemoryToIceAdapter.cpp.

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

◆ reloadAllFromLTM()

armem::CommitResult reloadAllFromLTM ( )

Loads all core segments and their data from the LTM.

Definition at line 420 of file MemoryToIceAdapter.cpp.

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

◆ reloadCoreSegmentsFromLTM()

armem::CommitResult reloadCoreSegmentsFromLTM ( std::list< std::string > &  coreSegmentname)

Only load specific core segments and their data from the LTM.

Definition at line 440 of file MemoryToIceAdapter.cpp.

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

◆ reloadFromLTMOnStartup()

armem::CommitResult reloadFromLTMOnStartup ( )

Triggers a reload (.

See also
reloadFromLTM) only if load on startup property is set. Loads only the core segments defined in the property 'loadedCoreSegments'

Definition at line 496 of file MemoryToIceAdapter.cpp.

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

◆ reloadPropertyDefinedCoreSegmentsFromLTM()

armem::CommitResult reloadPropertyDefinedCoreSegmentsFromLTM ( )

Definition at line 471 of file MemoryToIceAdapter.cpp.

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

◆ setMemoryListener()

void setMemoryListener ( client::MemoryListenerInterfacePrx  memoryListenerTopic)

Definition at line 36 of file MemoryToIceAdapter.cpp.

+ Here is the caller graph for this function:

◆ startRecord()

dto::StartRecordResult startRecord ( const dto::StartRecordInput &  startRecordInput)

Definition at line 532 of file MemoryToIceAdapter.cpp.

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

◆ stopRecord()

dto::StopRecordResult stopRecord ( )

Definition at line 546 of file MemoryToIceAdapter.cpp.

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

Member Data Documentation

◆ longtermMemory

server::ltm::Memory* longtermMemory

Definition at line 90 of file MemoryToIceAdapter.h.

◆ memoryListenerTopic

client::MemoryListenerInterfacePrx memoryListenerTopic

Definition at line 92 of file MemoryToIceAdapter.h.

◆ workingMemory

server::wm::Memory* workingMemory

Definition at line 89 of file MemoryToIceAdapter.h.


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