SkillsMemory Class Reference

Brief description of class SkillsMemory. More...

#include <RobotAPI/components/armem/server/SkillsMemory/SkillsMemory.h>

+ Inheritance diagram for SkillsMemory:

Public Member Functions

void addProvider (const skills::manager::dto::ProviderInfo &info, const Ice::Current &current) override
 
armem::data::CommitResult commit (const armem::data::Commit &commit, const Ice::Current &) override
 
skills::manager::dto::SkillStatusUpdate executeSkill (const skills::manager::dto::SkillExecutionRequest &info, const Ice::Current &current) override
 
skills::manager::dto::SkillExecutionID executeSkillAsync (const skills::manager::dto::SkillExecutionRequest &info, const Ice::Current &current) override
 
std::string getDefaultName () const override
 
IceUtil::Optional< skills::manager::dto::SkillStatusUpdate > getSkillExecutionStatus (const skills::manager::dto::SkillExecutionID &executionId, const Ice::Current &current) override
 
skills::manager::dto::SkillStatusUpdateMap getSkillExecutionStatuses (const Ice::Current &current) override
 
void removeProvider (const skills::manager::dto::ProviderID &provider, const Ice::Current &current) override
 
void reportStatechartTransitionWithParameters (const ProfilerStatechartTransitionWithParameters &, const Ice::Current &) override
 
void reportStatechartTransitionWithParametersList (const ProfilerStatechartTransitionWithParametersList &, const Ice::Current &) override
 
 SkillsMemory ()
 
void updateStatusForSkill (const skills::provider::dto::SkillStatusUpdate &update, const skills::callback::dto::ProviderID &id, const Ice::Current &current) override
 
- Public Member Functions inherited from Component
virtual void componentPropertiesUpdated (const std::set< std::string > &changedProperties)
 Implement this function if you would like to react to changes in the properties. More...
 
void forceComponentCreatedByComponentCreateFunc ()
 forces the flag to be set to true that the object instance was created by the Component::create function More...
 
std::vector< PropertyUserPtrgetAdditionalPropertyUsers () const
 
template<typename PropertyType >
Property< PropertyType > getProperty (const std::string &name)
 
template<typename PropertyType >
Property< PropertyType > getProperty (const std::string &name) const
 
template<class T >
void getProperty (std::atomic< T > &val, const std::string &name) const
 
template<class T >
void getProperty (T &val, const std::string &name) const
 
template<class ProxyType >
ProxyType getProxyFromProperty (const std::string &propertyName, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
 Get a proxy whose name is specified by the given property. More...
 
template<class ProxyType >
void getProxyFromProperty (ProxyType &proxy, const std::string &propertyName, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
 
template<class TopicProxyType >
TopicProxyType getTopicFromProperty (const std::string &propertyName)
 Get a topic proxy whose name is specified by the given property. More...
 
template<class TopicProxyType >
void getTopicFromProperty (TopicProxyType &top, const std::string &propertyName)
 
void initializeProperties (const std::string &configName, Ice::PropertiesPtr const &properties, const std::string &configDomain)
 initializes the properties of this component. More...
 
void injectPropertyDefinitions (PropertyDefinitionsPtr &props) override
 
void offeringTopicFromProperty (const std::string &propertyName)
 Offer a topic whose name is specified by the given property. More...
 
virtual void preOnConnectComponent () override
 
virtual void preOnInitComponent () override
 
bool usingProxyFromProperty (const std::string &propertyName, const std::string &endpoints="")
 Use a proxy whose name is specified by the given property. More...
 
void usingTopicFromProperty (const std::string &propertyName, bool orderedPublishing=false)
 Use a topic whose name is specified by the given property. More...
 
- 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...
 
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 PropertyUser
std::vector< std::string > getComponentProxyNames ()
 
Ice::PropertiesPtr getIceProperties () const
 Returns the set of Ice properties. More...
 
template<typename PropertyType >
Property< PropertyType > getProperty (const std::string &name)
 Property creation and retrieval. More...
 
template<typename PropertyType >
Property< PropertyType > getProperty (const std::string &name) const
 Hack to allow using getProperty in const-modified methods. More...
 
template<class T >
void getProperty (std::atomic< T > &val, const std::string &name) const
 
template<class T >
void getProperty (T &val, const std::string &name) const
 
template<class T >
std::vector< TgetPropertyAsCSV (const std::string &name, const std::string &splitBy=",;", bool trimElements=true, bool removeEmptyElements=true)
 
template<class ContainerT >
void getPropertyAsCSV (ContainerT &val, const std::string &name, const std::string &splitBy=",;", bool trimElements=true, bool removeEmptyElements=true)
 
PropertyDefinitionsPtr getPropertyDefinitions ()
 Returns the component's property definition container. More...
 
std::vector< std::string > getSubscribedTopicNames ()
 
std::vector< std::string > getTopicProxyNames ()
 
bool hasProperty (const std::string &name)
 
 PropertyUser ()
 
virtual void setIceProperties (Ice::PropertiesPtr properties)
 Sets the Ice properties. More...
 
bool tryAddProperty (const std::string &propertyName, const std::string &value)
 
virtual void updateIceProperties (const std::map< std::string, std::string > &changes)
 
void updateProperties ()
 
void updateProxies (IceManagerPtr)
 
 ~PropertyUser () override
 
- Public Member Functions inherited from ReadWritePluginUser
data::AddSegmentsResult addSegments (const data::AddSegmentsInput &input, bool addCoreSegments)
 
virtual data::AddSegmentsResult addSegments (const data::AddSegmentsInput &input, const Ice::Current &=Ice::emptyCurrent) override
 
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 ()
 
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
 
 ReadWritePluginUser ()
 
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
 
server::wm::MemoryworkingMemory ()
 
virtual ~ReadWritePluginUser () override
 
- Public Member Functions inherited from PluginUser
MemoryNameSystemmemoryNameSystem ()
 
const MemoryNameSystemmemoryNameSystem () const
 
- Public Member Functions inherited from StatechartListenerComponentPluginUser
void reportEvent (const ProfilerEvent &, const Ice::Current &) override
 
void reportEventList (const ProfilerEventList &events, const Ice::Current &) override
 
void reportNetworkTraffic (const std::string &, const std::string &, Ice::Int, Ice::Int, const Ice::Current &) override
 
void reportProcessCpuUsage (const ProfilerProcessCpuUsage &, const Ice::Current &) override
 
void reportProcessCpuUsageList (const ProfilerProcessCpuUsageList &, const Ice::Current &) override
 
void reportProcessMemoryUsage (const ProfilerProcessMemoryUsage &, const Ice::Current &) override
 
void reportProcessMemoryUsageList (const ProfilerProcessMemoryUsageList &, const Ice::Current &) override
 
void reportStatechartInputParameters (const ProfilerStatechartParameters &event, const Ice::Current &) override
 
void reportStatechartInputParametersList (const ProfilerStatechartParametersList &data, const Ice::Current &) override
 
void reportStatechartLocalParameters (const ProfilerStatechartParameters &event, const Ice::Current &) override
 
void reportStatechartLocalParametersList (const ProfilerStatechartParametersList &, const Ice::Current &) override
 
void reportStatechartOutputParameters (const ProfilerStatechartParameters &, const Ice::Current &) override
 
void reportStatechartOutputParametersList (const ProfilerStatechartParametersList &, const Ice::Current &) override
 
void reportStatechartTransition (const ProfilerStatechartTransition &event, const Ice::Current &) override
 
void reportStatechartTransitionList (const ProfilerStatechartTransitionList &, const Ice::Current &) override
 
 StatechartListenerComponentPluginUser ()
 
- Public Member Functions inherited from SkillManagerComponentPluginUser
skills::provider::dto::AbortSkillResult abortSkill (const skills::manager::dto::SkillExecutionID &id, const Ice::Current &current) override
 
skills::provider::dto::AbortSkillResult abortSkillAsync (const skills::manager::dto::SkillExecutionID &id, const Ice::Current &current) override
 
void addProvider (const skills::manager::dto::ProviderInfo &providerInfo, const Ice::Current &current) override
 
skills::manager::dto::SkillStatusUpdate executeSkill (const skills::manager::dto::SkillExecutionRequest &info, const Ice::Current &current) override
 
skills::manager::dto::SkillExecutionID executeSkillAsync (const skills::manager::dto::SkillExecutionRequest &skillExecutionRequest, const Ice::Current &current) override
 
IceUtil::Optional< skills::manager::dto::SkillDescription > getSkillDescription (const skills::manager::dto::SkillID &id, const Ice::Current &current) override
 
skills::manager::dto::SkillDescriptionMap getSkillDescriptions (const Ice::Current &current) override
 
IceUtil::Optional< skills::manager::dto::SkillStatusUpdate > getSkillExecutionStatus (const skills::manager::dto::SkillExecutionID &executionId, const Ice::Current &current) override
 
skills::manager::dto::SkillStatusUpdateMap getSkillExecutionStatuses (const Ice::Current &current) override
 
void removeProvider (const skills::manager::dto::ProviderID &provider, const Ice::Current &current) override
 
 SkillManagerComponentPluginUser ()
 
skills::provider::dto::ParameterUpdateResult updateSkillParameters (const skills::manager::dto::SkillExecutionID &executionId, const aron::data::dto::DictPtr &params, const Ice::Current &current) override
 
void updateStatusForSkill (const skills::provider::dto::SkillStatusUpdate &update, const skills::callback::dto::ProviderID &id, const Ice::Current &current) override
 

Protected Member Functions

armarx::PropertyDefinitionsPtr createPropertyDefinitions () override
 
void onConnectComponent () override
 
void onDisconnectComponent () override
 
void onExitComponent () override
 
void onInitComponent () override
 
- Protected Member Functions inherited from Component
void addPropertyUser (const PropertyUserPtr &subPropertyUser)
 Add additional property users here that should show up in the application help text. More...
 
 Component ()
 Protected default constructor. Used for virtual inheritance. Use createManagedIceObject() instead. More...
 
std::string getConfigDomain ()
 Retrieve config domain for this component as set in constructor. More...
 
std::string getConfigIdentifier ()
 Retrieve config identifier for this component as set in constructor. More...
 
std::string getConfigName ()
 Retrieve config name for this component as set in constructor. More...
 
virtual void icePropertiesInitialized ()
 
- 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 postOnConnectComponent ()
 
virtual void postOnDisconnectComponent ()
 
virtual void postOnExitComponent ()
 
virtual void postOnInitComponent ()
 
virtual void preOnDisconnectComponent ()
 
virtual void preOnExitComponent ()
 
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
 

Additional Inherited Members

- Public Types inherited from ManagedIceObject
using PeriodicTaskPtr = IceUtil::Handle< SimplePeriodicTask< std::function< void(void)> >>
 
- Static Public Member Functions inherited from Component
template<class T , class TPtr = IceInternal::Handle<T>>
static TPtr create (Ice::PropertiesPtr properties=Ice::createProperties(), const std::string &configName="", const std::string &configDomain="ArmarX")
 Factory method for a component. More...
 
- 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 Attributes inherited from Logging
MessageTypeT minimumLoggingLevel
 
SpamFilterDataPtr spamFilter
 
LogTag tag
 

Detailed Description

Brief description of class SkillsMemory.

Detailed description of class SkillsMemory.

Definition at line 55 of file SkillsMemory.h.

Constructor & Destructor Documentation

◆ SkillsMemory()

Definition at line 42 of file SkillsMemory.cpp.

Member Function Documentation

◆ addProvider()

void addProvider ( const skills::manager::dto::ProviderInfo &  info,
const Ice::Current &  current 
)
override

Definition at line 128 of file SkillsMemory.cpp.

+ Here is the call graph for this function:

◆ commit()

armem::data::CommitResult commit ( const armem::data::Commit &  commit,
const Ice::Current &  current 
)
override

Definition at line 99 of file SkillsMemory.cpp.

+ Here is the call graph for this function:

◆ createPropertyDefinitions()

armarx::PropertyDefinitionsPtr createPropertyDefinitions ( )
overrideprotectedvirtual
See also
PropertyUser::createPropertyDefinitions()

Reimplemented from Component.

Definition at line 54 of file SkillsMemory.cpp.

+ Here is the call graph for this function:

◆ executeSkill()

skills::manager::dto::SkillStatusUpdate executeSkill ( const skills::manager::dto::SkillExecutionRequest &  info,
const Ice::Current &  current 
)
override

Definition at line 150 of file SkillsMemory.cpp.

+ Here is the call graph for this function:

◆ executeSkillAsync()

skills::manager::dto::SkillExecutionID executeSkillAsync ( const skills::manager::dto::SkillExecutionRequest &  info,
const Ice::Current &  current 
)
override

Definition at line 160 of file SkillsMemory.cpp.

+ Here is the call graph for this function:

◆ getDefaultName()

std::string getDefaultName ( ) const
overridevirtual
See also
armarx::ManagedIceObject::getDefaultName()

Implements ManagedIceObject.

Definition at line 69 of file SkillsMemory.cpp.

◆ getSkillExecutionStatus()

IceUtil::Optional< skills::manager::dto::SkillStatusUpdate > getSkillExecutionStatus ( const skills::manager::dto::SkillExecutionID &  executionId,
const Ice::Current &  current 
)
override

Definition at line 180 of file SkillsMemory.cpp.

+ Here is the call graph for this function:

◆ getSkillExecutionStatuses()

skills::manager::dto::SkillStatusUpdateMap getSkillExecutionStatuses ( const Ice::Current &  current)
override

Definition at line 193 of file SkillsMemory.cpp.

+ Here is the call graph for this function:

◆ onConnectComponent()

void onConnectComponent ( )
overrideprotectedvirtual

◆ onDisconnectComponent()

void onDisconnectComponent ( )
overrideprotectedvirtual
See also
armarx::ManagedIceObject::onDisconnectComponent()

Reimplemented from ManagedIceObject.

Definition at line 89 of file SkillsMemory.cpp.

◆ onExitComponent()

void onExitComponent ( )
overrideprotectedvirtual
See also
armarx::ManagedIceObject::onExitComponent()

Reimplemented from ManagedIceObject.

Definition at line 94 of file SkillsMemory.cpp.

◆ onInitComponent()

void onInitComponent ( )
overrideprotectedvirtual
See also
armarx::ManagedIceObject::onInitComponent()

Implements ManagedIceObject.

Definition at line 75 of file SkillsMemory.cpp.

+ Here is the call graph for this function:

◆ removeProvider()

void removeProvider ( const skills::manager::dto::ProviderID &  provider,
const Ice::Current &  current 
)
override

Definition at line 140 of file SkillsMemory.cpp.

+ Here is the call graph for this function:

◆ reportStatechartTransitionWithParameters()

void reportStatechartTransitionWithParameters ( const ProfilerStatechartTransitionWithParameters &  x,
const Ice::Current &   
)
override

Definition at line 208 of file SkillsMemory.cpp.

+ Here is the call graph for this function:

◆ reportStatechartTransitionWithParametersList()

void reportStatechartTransitionWithParametersList ( const ProfilerStatechartTransitionWithParametersList &  x,
const Ice::Current &   
)
override

Definition at line 216 of file SkillsMemory.cpp.

+ Here is the call graph for this function:

◆ updateStatusForSkill()

void updateStatusForSkill ( const skills::provider::dto::SkillStatusUpdate &  update,
const skills::callback::dto::ProviderID &  id,
const Ice::Current &  current 
)
override

Definition at line 170 of file SkillsMemory.cpp.

+ Here is the call graph for this function:

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