ReadWritePluginUser Class Reference

Base class of memory server components. More...

#include <RobotAPI/libraries/armem/server/plugins/ReadWritePluginUser.h>

+ Inheritance diagram for ReadWritePluginUser:

Public Member Functions

data::AddSegmentsResult addSegments (const data::AddSegmentsInput &input, bool addCoreSegments)
 
virtual data::AddSegmentsResult addSegments (const data::AddSegmentsInput &input, const Ice::Current &=Ice::emptyCurrent) override
 
virtual void clearWorkingMemory (const Ice::Current &=Ice::emptyCurrent) override
 Clears the working memory usings its clear feature. More...
 
virtual data::CommitResult commit (const data::Commit &commit, const Ice::Current &=Ice::emptyCurrent) override
 
virtual dto::DirectlyStoreResult directlyStore (const dto::DirectlyStoreInput &, const Ice::Current &=Ice::emptyCurrent) override
 
virtual armem::actions::ExecuteActionOutputSeq executeActions (const armem::actions::ExecuteActionInputSeq &inputs)
 
virtual armem::actions::ExecuteActionOutputSeq executeActions (const armem::actions::ExecuteActionInputSeq &inputs, const ::Ice::Current &) override
 
virtual armem::actions::GetActionsOutputSeq getActions (const armem::actions::GetActionsInputSeq &inputs)
 
virtual armem::actions::GetActionsOutputSeq getActions (const armem::actions::GetActionsInputSeq &inputs, const ::Ice::Current &) override
 
virtual armem::prediction::data::EngineSupportMap getAvailableEngines ()
 
virtual armem::prediction::data::EngineSupportMap getAvailableEngines (const ::Ice::Current &) override
 
virtual dto::RecordStatusResult getRecordStatus (const Ice::Current &=Ice::emptyCurrent) override
 
virtual armem::structure::data::GetServerStructureResult getServerStructure (const Ice::Current &=Ice::emptyCurrent) override
 
MemoryToIceAdaptericeAdapter ()
 
virtual void loadLTMintoWM (bool complete, const ::Ice::Current &) override
 Loads the data of the LTMs into the WM. More...
 
server::ltm::MemorylongtermMemory ()
 
PluginmemoryServerPlugin ()
 
virtual armem::prediction::data::PredictionResultSeq predict (const armem::prediction::data::PredictionRequestSeq &requests)
 
virtual armem::prediction::data::PredictionResultSeq predict (const armem::prediction::data::PredictionRequestSeq &requests, const ::Ice::Current &) override
 
virtual armem::query::data::Result query (const armem::query::data::Input &input, const Ice::Current &=Ice::emptyCurrent) override
 
virtual armem::query::data::Result queryLTM (const armem::query::data::Input &input, bool storeIntoWM, const Ice::Current &=Ice::emptyCurrent) override
 Queries only the LTMs of the memory server. More...
 
 ReadWritePluginUser ()
 
armem::CommitResult reloadFromLTM ()
 
void setMemoryName (const std::string &memoryName)
 
virtual dto::StartRecordResult startRecord (const dto::StartRecordInput &startRecordInput, const Ice::Current &=Ice::emptyCurrent) override
 
virtual dto::StopRecordResult stopRecord (const Ice::Current &=Ice::emptyCurrent) override
 
virtual void useDiskPersistenceStrategy (const std::string &identifier, const std::string &exportName, const std::string &exportPath, bool overwritePrevStrategy, const ::Ice::Current &) override
 Use a disk persistence strategy for storing the wm as ltm Uses the disk as ltm sink. More...
 
virtual void useMongoDbPersistenceStrategy (const std::string &identifier, const std::string &exportName, bool overwritePrevStrategy, const ::Ice::Current &) override
 Use a mongodb persistence strategy for storing the wm as ltm Uses a mongodb as ltm sink. More...
 
virtual void useRestPersistenceStrategy (const std::string &identifier, const std::string &exportName, const std::string &host, int port, bool overwritePrevStrategy, const ::Ice::Current &) override
 Use a rest persistence strategy for storing the wm as ltm Uses a rest server as ltm sink. More...
 
server::wm::MemoryworkingMemory ()
 
virtual ~ReadWritePluginUser () override
 
- Public Member Functions inherited from ManagedIceObject
void enableProfiler (bool enable)
 setProfiler allows setting ManagedIceObject::profiler to a new instance (if the new instance is actually not a null pointer) More...
 
std::string generateSubObjectName (const std::string &subObjectName)
 Generates a unique name for a sub object from a general name. More...
 
ArmarXManagerPtr getArmarXManager () const
 Returns the ArmarX manager used to add and remove components. More...
 
ManagedIceObjectConnectivity getConnectivity () const
 Retrieve connectivity of the object (topcis as well as proxies) More...
 
virtual std::string getDefaultName () const =0
 Retrieve default name of component. More...
 
IceManagerPtr getIceManager () const
 Returns the IceManager. More...
 
VariantBasePtr getMetaInfo (const std::string &id)
 
StringVariantBaseMap getMetaInfoMap () const
 
std::string getName () const
 Retrieve name of object. More...
 
Ice::ObjectAdapterPtr getObjectAdapter () const
 Returns object's Ice adapter. More...
 
ArmarXObjectSchedulerPtr getObjectScheduler () const
 
PeriodicTaskPtr getPeriodicTask (const std::string &name)
 
Profiler::ProfilerPtr getProfiler () const
 getProfiler returns an instance of armarx::Profiler More...
 
template<class ProxyTarg , class... Args>
void getProxy (const char *name, IceInternal::ProxyHandle< ProxyTarg > &proxy, Args &&... args)
 
template<class ProxyType >
ProxyType getProxy (const std::string &name, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
 Retrieves a proxy object. More...
 
template<class ProxyTarg , class... Args>
void getProxy (const std::string &name, IceInternal::ProxyHandle< ProxyTarg > &proxy, Args &&... args)
 
template<class ProxyTarg , class... Args>
void getProxy (IceInternal::ProxyHandle< ProxyTarg > &proxy, const char *name, Args &&... args)
 
template<class ProxyTarg , class... Args>
void getProxy (IceInternal::ProxyHandle< ProxyTarg > &proxy, const std::string &name, Args &&... args)
 Assigns a proxy to proxy. More...
 
Ice::ObjectPrx getProxy (long timeoutMs=0, bool waitForScheduler=true) const
 Returns the proxy of this object (optionally it waits for the proxy) More...
 
template<class Prx >
Prx getProxy (long timeoutMs=0, bool waitForScheduler=true) const
 
template<class ProxyType >
void getProxy (ProxyType &proxy, const char *name, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
 Overload to allow using string literals as name (solve ambiguous overload). More...
 
template<class Prx >
void getProxy (Prx &prx, long timeoutMs=0, bool waitForScheduler=true) const
 
int getState () const
 Retrieve current state of the ManagedIceObject. More...
 
template<class TopicProxyType >
TopicProxyType getTopic (const std::string &name)
 Returns a proxy of the specified topic. More...
 
template<class TopicProxyType >
void getTopic (TopicProxyType &topicProxy, const std::string &name)
 Assigns a proxy of the specified topic to topicProxy. More...
 
std::vector< std::string > getUnresolvedDependencies () const
 returns the names of all unresolved dependencies More...
 
 ManagedIceObject (ManagedIceObject const &other)
 
void offeringTopic (const std::string &name)
 Registers a topic for retrival after initialization. More...
 
void preambleGetTopic (std::string const &name)
 
void setMetaInfo (const std::string &id, const VariantBasePtr &value)
 Allows to set meta information that can be queried live via Ice interface on the ArmarXManager. More...
 
void startPeriodicTask (const std::string &uniqueName, std::function< void(void)> f, int periodMs, bool assureMeanInterval=false, bool forceSystemTime=true)
 
bool stopPeriodicTask (const std::string &name)
 
bool unsubscribeFromTopic (const std::string &name)
 Unsubscribe from a topic. More...
 
bool usingProxy (const std::string &name, const std::string &endpoints="")
 Registers a proxy for retrieval after initialization and adds it to the dependency list. More...
 
void usingTopic (const std::string &name, bool orderedPublishing=false)
 Registers a proxy for subscription after initialization. More...
 
void waitForObjectScheduler ()
 Waits until the ObjectScheduler could resolve all dependencies. More...
 
void waitForProxy (std::string const &name, bool addToDependencies)
 
- Public Member Functions inherited from Logging
SpamFilterDataPtr deactivateSpam (float deactivationDurationSec=10.0f, const std::string &identifier="", bool deactivate=true) const
 disables the logging for the current line for the given amount of seconds. More...
 
MessageTypeT getEffectiveLoggingLevel () const
 
 Logging ()
 
void setLocalMinimumLoggingLevel (MessageTypeT level)
 With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set. More...
 
void setTag (const LogTag &tag)
 
void setTag (const std::string &tagName)
 
virtual ~Logging ()
 
- Public Member Functions inherited from PluginUser
MemoryNameSystemmemoryNameSystem ()
 
const MemoryNameSystemmemoryNameSystem () const
 

Additional Inherited Members

- Public Types inherited from ManagedIceObject
using PeriodicTaskPtr = IceUtil::Handle< SimplePeriodicTask< std::function< void(void)> >>
 
- Static Public Member Functions inherited from ManagedIceObject
static std::string generateSubObjectName (const std::string &superObjectName, const std::string &subObjectName)
 Generates a unique name for a sub object from a general name and unique name. More...
 
static std::string GetObjectStateAsString (int state)
 
- Static Public Attributes inherited from ManagedIceObject
static const ManagedIceObjectPtr NullPtr
 A nullptr to be used when a const ref to a nullptr is required. More...
 
- Protected Member Functions inherited from ManagedIceObject
template<class PluginT , class... ParamsT>
PluginT * addPlugin (const std::string prefix="", ParamsT &&... params)
 
template<class PluginT , class... ParamsT>
void addPlugin (PluginT *&targ, const std::string prefix="", ParamsT &&... params)
 
template<class PluginT , class... ParamsT>
void addPlugin (std::experimental::observer_ptr< PluginT > &targ, const std::string prefix="", ParamsT &&... params)
 
Ice::CommunicatorPtr getCommunicator () const
 
std::unique_ptr< ManagedIceObjectPlugin > & getPluginPointer (std::type_info const &type, std::string const &prefix)
 
 ManagedIceObject ()
 Protected default constructor. More...
 
virtual void onConnectComponent ()=0
 Pure virtual hook for the subclass. More...
 
virtual void onDisconnectComponent ()
 Hook for subclass. More...
 
virtual void onExitComponent ()
 Hook for subclass. More...
 
virtual void onInitComponent ()=0
 Pure virtual hook for the subclass. More...
 
virtual void postOnConnectComponent ()
 
virtual void postOnDisconnectComponent ()
 
virtual void postOnExitComponent ()
 
virtual void postOnInitComponent ()
 
virtual void preOnConnectComponent ()
 
virtual void preOnDisconnectComponent ()
 
virtual void preOnExitComponent ()
 
virtual void preOnInitComponent ()
 
bool removeProxyDependency (const std::string &name)
 This function removes the dependency of this object on the in parameter name specified object. More...
 
void setName (std::string name)
 Override name of well-known object. More...
 
void terminate ()
 Initiates termination of this IceManagedObject. More...
 
 ~ManagedIceObject () override
 
- Protected Member Functions inherited from Logging
bool checkLogLevel (MessageTypeT level) const
 
const LogSenderPtrgetLogSender () const
 Retrieve log sender. More...
 
LogSenderPtr loghelper (const char *file, int line, const char *function) const
 
- Protected Member Functions inherited from ListeningPluginUser
 ListeningPluginUser ()
 
virtual void memoryUpdated (const std::vector< data::MemoryID > &updatedSnapshotIDs, const Ice::Current &) override
 
virtual ~ListeningPluginUser () override
 
- Protected Member Functions inherited from PluginUser
 PluginUser ()
 
virtual ~PluginUser () override
 
- Protected Attributes inherited from Logging
MessageTypeT minimumLoggingLevel
 
SpamFilterDataPtr spamFilter
 
LogTag tag
 

Detailed Description

Base class of memory server components.

Implements the server ice interfaces using the ice adapter of the plugin.

Definition at line 21 of file ReadWritePluginUser.h.

Constructor & Destructor Documentation

◆ ReadWritePluginUser()

Definition at line 19 of file ReadWritePluginUser.cpp.

+ Here is the call graph for this function:

◆ ~ReadWritePluginUser()

~ReadWritePluginUser ( )
overridevirtual

Definition at line 24 of file ReadWritePluginUser.cpp.

Member Function Documentation

◆ addSegments() [1/2]

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

Definition at line 44 of file ReadWritePluginUser.cpp.

+ Here is the call graph for this function:

◆ addSegments() [2/2]

data::AddSegmentsResult addSegments ( const data::AddSegmentsInput &  input,
const Ice::Current &  = Ice::emptyCurrent 
)
overridevirtual

Definition at line 36 of file ReadWritePluginUser.cpp.

+ Here is the caller graph for this function:

◆ clearWorkingMemory()

void clearWorkingMemory ( const Ice::Current &  = Ice::emptyCurrent)
overridevirtual

Clears the working memory usings its clear feature.

Definition at line 58 of file ReadWritePluginUser.cpp.

+ Here is the call graph for this function:

◆ commit()

data::CommitResult commit ( const data::Commit &  commit,
const Ice::Current &  = Ice::emptyCurrent 
)
overridevirtual

Definition at line 52 of file ReadWritePluginUser.cpp.

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

◆ directlyStore()

dto::DirectlyStoreResult directlyStore ( const dto::DirectlyStoreInput &  input,
const Ice::Current &  = Ice::emptyCurrent 
)
overridevirtual

Definition at line 93 of file ReadWritePluginUser.cpp.

+ Here is the call graph for this function:

◆ executeActions() [1/2]

armem::actions::ExecuteActionOutputSeq executeActions ( const armem::actions::ExecuteActionInputSeq &  inputs)
virtual

Reimplemented in ObjectMemory, GraspMemory, and ExampleMemory.

Definition at line 168 of file ReadWritePluginUser.cpp.

+ Here is the caller graph for this function:

◆ executeActions() [2/2]

armem::actions::ExecuteActionOutputSeq executeActions ( const armem::actions::ExecuteActionInputSeq &  inputs,
const ::Ice::Current &   
)
overridevirtual

Definition at line 161 of file ReadWritePluginUser.cpp.

+ Here is the call graph for this function:

◆ getActions() [1/2]

armem::actions::GetActionsOutputSeq getActions ( const armem::actions::GetActionsInputSeq &  inputs)
virtual

Reimplemented in ObjectMemory, GraspMemory, and ExampleMemory.

Definition at line 154 of file ReadWritePluginUser.cpp.

+ Here is the caller graph for this function:

◆ getActions() [2/2]

armem::actions::GetActionsOutputSeq getActions ( const armem::actions::GetActionsInputSeq &  inputs,
const ::Ice::Current &   
)
overridevirtual

Definition at line 147 of file ReadWritePluginUser.cpp.

+ Here is the call graph for this function:

◆ getAvailableEngines() [1/2]

armem::prediction::data::EngineSupportMap getAvailableEngines ( )
virtual

Definition at line 181 of file ReadWritePluginUser.cpp.

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

◆ getAvailableEngines() [2/2]

armem::prediction::data::EngineSupportMap getAvailableEngines ( const ::Ice::Current &  )
overridevirtual

Definition at line 194 of file ReadWritePluginUser.cpp.

+ Here is the call graph for this function:

◆ getRecordStatus()

dto::RecordStatusResult getRecordStatus ( const Ice::Current &  = Ice::emptyCurrent)
overridevirtual

Definition at line 115 of file ReadWritePluginUser.cpp.

+ Here is the call graph for this function:

◆ getServerStructure()

structure::data::GetServerStructureResult getServerStructure ( const Ice::Current &  = Ice::emptyCurrent)
overridevirtual

Definition at line 85 of file ReadWritePluginUser.cpp.

+ Here is the call graph for this function:

◆ iceAdapter()

MemoryToIceAdapter & iceAdapter ( )

Definition at line 134 of file ReadWritePluginUser.cpp.

+ Here is the caller graph for this function:

◆ loadLTMintoWM()

void loadLTMintoWM ( bool  complete,
const ::Ice::Current &   
)
overridevirtual

Loads the data of the LTMs into the WM.

Definition at line 267 of file ReadWritePluginUser.cpp.

+ Here is the call graph for this function:

◆ longtermMemory()

ltm::Memory & longtermMemory ( )

Definition at line 140 of file ReadWritePluginUser.cpp.

+ Here is the caller graph for this function:

◆ memoryServerPlugin()

Plugin & memoryServerPlugin ( )

Definition at line 122 of file ReadWritePluginUser.cpp.

◆ predict() [1/2]

armem::prediction::data::PredictionResultSeq predict ( const armem::prediction::data::PredictionRequestSeq &  requests)
virtual

Reimplemented in ObjectMemory.

Definition at line 175 of file ReadWritePluginUser.cpp.

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

◆ predict() [2/2]

armem::prediction::data::PredictionResultSeq predict ( const armem::prediction::data::PredictionRequestSeq &  requests,
const ::Ice::Current &   
)
overridevirtual

Definition at line 187 of file ReadWritePluginUser.cpp.

+ Here is the call graph for this function:

◆ query()

armem::query::data::Result query ( const armem::query::data::Input &  input,
const Ice::Current &  = Ice::emptyCurrent 
)
overridevirtual

Definition at line 71 of file ReadWritePluginUser.cpp.

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

◆ queryLTM()

armem::query::data::Result queryLTM ( const armem::query::data::Input &  input,
bool  storeIntoWM,
const Ice::Current &  = Ice::emptyCurrent 
)
overridevirtual

Queries only the LTMs of the memory server.

Parameters
storeIntoWMif set, the result is also stored into the working memory no matter how the recording mode is set.

Definition at line 78 of file ReadWritePluginUser.cpp.

+ Here is the call graph for this function:

◆ reloadFromLTM()

armem::CommitResult reloadFromLTM ( )

Definition at line 200 of file ReadWritePluginUser.cpp.

+ Here is the call graph for this function:

◆ setMemoryName()

void setMemoryName ( const std::string &  memoryName)

Definition at line 29 of file ReadWritePluginUser.cpp.

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

◆ startRecord()

dto::StartRecordResult startRecord ( const dto::StartRecordInput &  startRecordInput,
const Ice::Current &  = Ice::emptyCurrent 
)
overridevirtual

Definition at line 100 of file ReadWritePluginUser.cpp.

+ Here is the call graph for this function:

◆ stopRecord()

dto::StopRecordResult stopRecord ( const Ice::Current &  = Ice::emptyCurrent)
overridevirtual

Definition at line 108 of file ReadWritePluginUser.cpp.

+ Here is the call graph for this function:

◆ useDiskPersistenceStrategy()

void useDiskPersistenceStrategy ( const std::string &  identifier,
const std::string &  exportName,
const std::string &  exportPath,
bool  overwritePrevStrategy,
const ::Ice::Current &   
)
overridevirtual

Use a disk persistence strategy for storing the wm as ltm Uses the disk as ltm sink.

Parameters
identifierunique strategy name
exportNamememory export name
exportPathpath where the export is stored on disk
overwritePrevStrategyif set the ltm only contains this new strategy, if false it will be appended to the other(s)

Definition at line 236 of file ReadWritePluginUser.cpp.

+ Here is the call graph for this function:

◆ useMongoDbPersistenceStrategy()

void useMongoDbPersistenceStrategy ( const std::string &  identifier,
const std::string &  exportName,
bool  overwritePrevStrategy,
const ::Ice::Current &   
)
overridevirtual

Use a mongodb persistence strategy for storing the wm as ltm Uses a mongodb as ltm sink.

NOTE (TODO): Not implemented

Definition at line 262 of file ReadWritePluginUser.cpp.

◆ useRestPersistenceStrategy()

void useRestPersistenceStrategy ( const std::string &  identifier,
const std::string &  exportName,
const std::string &  host,
int  port,
bool  overwritePrevStrategy,
const ::Ice::Current &   
)
overridevirtual

Use a rest persistence strategy for storing the wm as ltm Uses a rest server as ltm sink.

Parameters
identifierunique strategy name
exportNamememory export name
hostname of the host where the rest server is running
portnetwork port at which the rest server is running
overwritePrevStrategyif set the ltm only contains this new strategy, if false it will be appended to the other(s)

Definition at line 208 of file ReadWritePluginUser.cpp.

+ Here is the call graph for this function:

◆ workingMemory()

wm::Memory & workingMemory ( )

Definition at line 128 of file ReadWritePluginUser.cpp.

+ Here is the caller graph for this function:

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