MemoryXController Class Reference

#include <MemoryX/gui-plugins/SceneEditor/memoryxcontroller/MemoryXController.h>

Public Member Functions
std::vector< std::string >	getAllSnapshots ()
	Returns a list with the names of all existing snapshots.
controller::ControllerPtr	getController () const
	Returns the main controller of this plugin.
std::shared_ptr< PriorKnowledgeController >	getPriorKnowlegdeController () const
	Returns a shared pointer to the PriorKnowledgeController.
IceInternal::Handle< WorkingMemoryController >	getWorkingMemoryController () const
	Returns a shared pointer to the WorkingMemoryController.
void	init (const memoryx::PriorKnowledgeInterfacePrx &priorKnowledgePrx, const memoryx::WorkingMemoryInterfacePrx &workingMemoryPrx, const std::string &workingMemoryUpdatesTopic, const std::string &objectInstancesSegmentName, const memoryx::LongtermMemoryInterfacePrx &longtermMemoryPrx, const controller::ControllerPtr &mainController)
	Initialisates the MemoryXController.
std::vector< std::string >	loadSnapshot (const std::string &snapshotName)
	Loads the content of the snapshot with the given name and add it to the current working memory.
	MemoryXController ()
	Constructor.
bool	saveObjectsInSnapshot (std::string &snapshotName, const std::vector< std::string > &objectIds)
	Saves all object instances whose ids are given in a snapshot with the given name.
bool	saveSceneInSnapshot (std::string &snapshotName)
	Saves the whole content of the working memory in a snapshot with the given name.
	~MemoryXController ()
	Destructor.

Constructor & Destructor Documentation

MemoryXController()

MemoryXController

(

)

Constructor.

Creates an instance of this class.

~MemoryXController()

~MemoryXController

(

)

Destructor.

Member Function Documentation

getAllSnapshots()

std::vector< std::string > getAllSnapshots

(

)

Returns a list with the names of all existing snapshots.

Returns

std::vector<std::string> list of names of all existing snapshots

getController()

controller::ControllerPtr getController

(

)

const

Returns the main controller of this plugin.

Returns

controller::ControllerPtr the pointer to the main controller

getPriorKnowlegdeController()

std::shared_ptr< memoryxcontroller::PriorKnowledgeController > getPriorKnowlegdeController

(

)

const

Returns a shared pointer to the PriorKnowledgeController.

Returns

std::shared_ptr<PriorKnowledgeController> the pointer to the PriorKnowledgeController

getWorkingMemoryController()

IceInternal::Handle< memoryxcontroller::WorkingMemoryController > getWorkingMemoryController

(

)

const

Returns a shared pointer to the WorkingMemoryController.

Returns

IceInternal::Handle<WorkingMemoryController> the pointer to the WorkingMemoryController

init()

void init	(	const memoryx::PriorKnowledgeInterfacePrx &	priorKnowledgePrx,
		const memoryx::WorkingMemoryInterfacePrx &	workingMemoryPrx,
		const std::string &	workingMemoryUpdatesTopic,
		const std::string &	objectInstancesSegmentName,
		const memoryx::LongtermMemoryInterfacePrx &	longtermMemoryPrx,
		const controller::ControllerPtr &	mainController )

Initialisates the MemoryXController.

Parameters

priorKnowledgePrx	the proxy to the priorknowledge
workingMemoryPrx	the proxy to the working memory
workingMemoryUpdatesTopic	the name of the topic where changes of the working memory are reported
objectInstancesSegmentName	the name of the segment in the working memory where the object instances are stored
longtermMemoryPrx	the proxy to the longtermmemory where snapshots are stored
mainController	the controller of this programm

See also

controller::Controller

loadSnapshot()

std::vector< std::string > loadSnapshot

(

const std::string &

snapshotName

)

Loads the content of the snapshot with the given name and add it to the current working memory.

Returns a list with the ids of the added object instances. If there is no snapshot with the given name nothing is added to the working memory.

Parameters

snapshotName

the name of the snapshot that should be loaded

Returns

std::vector<std::string> the list with the ids of the added object instances

saveObjectsInSnapshot()

bool saveObjectsInSnapshot	(	std::string &	snapshotName,
		const std::vector< std::string > &	objectIds )

Saves all object instances whose ids are given in a snapshot with the given name.

Parameters

snapshotName	the name of the snapshot
objectIds	the list with the ids of the object instances that shold be saved

Returns

bool true when the saving was successful

saveSceneInSnapshot()

bool saveSceneInSnapshot

(

std::string &

snapshotName

)

Saves the whole content of the working memory in a snapshot with the given name.

If the given name does not start with 'Snapshot_', this prefix will be added.

Parameters

snapshotName

the name of the snapshot

Returns

bool true when the saving was successful

---

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

• MemoryX/gui-plugins/SceneEditor/memoryxcontroller/MemoryXController.h
• MemoryX/gui-plugins/SceneEditor/memoryxcontroller/MemoryXController.cpp