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 ()

const MemoryOperationStatistics &	getStatistics () const
	Get statistics for memory operations (commits and queries)

	MemoryToIceAdapter (server::wm::Memory workingMemory, server::ltm::Memory longtermMemory)
	Construct a MemoryToIceAdapter from an existing Memory.

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.

armem::CommitResult	reloadAllFromLTM ()
	Loads all core segments and their data from the LTM.

armem::CommitResult	reloadCoreSegmentsFromLTM (std::list< std::string > &coreSegmentname)
	Only load specific core segments and their data from the LTM.

armem::CommitResult	reloadFromLTMOnStartup ()
	Triggers a reload (.

armem::CommitResult	reloadPropertyDefinedCoreSegmentsFromLTM ()

void	reportDebugMetrics ()
	Report all debug metrics to the debug observer.

void	resetStatistics ()
	Reset statistics counters.

void	setMemoryListener (client::MemoryListenerInterfacePrx memoryListenerTopic)

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

dto::StopRecordResult	stopRecord ()

Public Attributes
server::ltm::Memory *	longtermMemory

client::MemoryListenerInterfacePrx	memoryListenerTopic

server::wm::Memory *	workingMemory

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 99 of file MemoryToIceAdapter.h.

Constructor & Destructor Documentation

◆ MemoryToIceAdapter()

MemoryToIceAdapter	(	server::wm::Memory *	workingMemory,
		server::ltm::Memory *	longtermMemory )

Construct a MemoryToIceAdapter from an existing Memory.

Both pointers are non-owning and must be non-null: the commit and query paths dereference them unconditionally. This is checked in the constructor.

Definition at line 89 of file MemoryToIceAdapter.cpp.

Member Function Documentation

◆ addSegment()

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

Definition at line 108 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 170 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 233 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 226 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 184 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 289 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 282 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 240 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 786 of file MemoryToIceAdapter.cpp.

Here is the call graph for this function:

◆ getAvailableEngines()

prediction::data::EngineSupportMap getAvailableEngines ( )

Definition at line 911 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 868 of file MemoryToIceAdapter.cpp.

Here is the caller graph for this function:

◆ getServerStructure()

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

Definition at line 658 of file MemoryToIceAdapter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStatistics()

const MemoryOperationStatistics & getStatistics ( ) const

inline

Get statistics for memory operations (commits and queries)

Definition at line 174 of file MemoryToIceAdapter.h.

◆ predict()

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

Definition at line 903 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 549 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 650 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

storeIntoWM if set the result is also stored into the wm, no matter the recording mode.

Definition at line 614 of file MemoryToIceAdapter.cpp.

Here is the call graph for this function:

◆ reloadAllFromLTM()

armem::CommitResult reloadAllFromLTM ( )

Loads all core segments and their data from the LTM.

Definition at line 689 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 709 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 765 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 740 of file MemoryToIceAdapter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reportDebugMetrics()

void reportDebugMetrics ( )

Report all debug metrics to the debug observer.

This should be called periodically (e.g., every second) to update the debug observer with current memory performance metrics.

Definition at line 941 of file MemoryToIceAdapter.cpp.

◆ resetStatistics()

void resetStatistics ( )

inline

Reset statistics counters.

Definition at line 177 of file MemoryToIceAdapter.h.

◆ setMemoryListener()

void setMemoryListener ( client::MemoryListenerInterfacePrx memoryListenerTopic )

Definition at line 101 of file MemoryToIceAdapter.cpp.

◆ startRecord()

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

Definition at line 801 of file MemoryToIceAdapter.cpp.

Here is the caller graph for this function:

◆ stopRecord()

dto::StopRecordResult stopRecord ( )

Definition at line 815 of file MemoryToIceAdapter.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ longtermMemory

server::ltm::Memory* longtermMemory

Definition at line 189 of file MemoryToIceAdapter.h.

◆ memoryListenerTopic

client::MemoryListenerInterfacePrx memoryListenerTopic

Definition at line 191 of file MemoryToIceAdapter.h.

◆ workingMemory

server::wm::Memory* workingMemory

Definition at line 188 of file MemoryToIceAdapter.h.

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

RobotAPI/libraries/armem/server/MemoryToIceAdapter.h
RobotAPI/libraries/armem/server/MemoryToIceAdapter.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MemoryToIceAdapter()

Member Function Documentation

◆ addSegment()

◆ addSegments()

◆ commit() [1/3]

◆ commit() [2/3]

◆ commit() [3/3]

◆ commitLocking() [1/3]

◆ commitLocking() [2/3]

◆ commitLocking() [3/3]

◆ directlyStore()

◆ getAvailableEngines()

◆ getRecordStatus()

◆ getServerStructure()

◆ getStatistics()

◆ predict()

◆ query() [1/2]

◆ query() [2/2]

◆ queryLTM()

◆ reloadAllFromLTM()

◆ reloadCoreSegmentsFromLTM()

◆ reloadFromLTMOnStartup()

◆ reloadPropertyDefinedCoreSegmentsFromLTM()

◆ reportDebugMetrics()

◆ resetStatistics()

◆ setMemoryListener()

◆ startRecord()

◆ stopRecord()

Member Data Documentation

◆ longtermMemory

◆ memoryListenerTopic

◆ workingMemory