SkillManagerComponentPlugin Class Reference

#include <RobotAPI/libraries/skills/manager/SkillManagerComponentPlugin.h>

+ Inheritance diagram for SkillManagerComponentPlugin:

Public Member Functions

bool abortSkill (const skills::SkillExecutionID &id)
 
bool abortSkillAsync (const skills::SkillExecutionID &id)
 
void addProvider (const skills::ProviderInfo &info)
 
skills::SkillStatusUpdate executeSkill (const skills::SkillExecutionRequest &req)
 
skills::SkillExecutionID executeSkillAsync (const skills::SkillExecutionRequest &req)
 
std::optional< skills::SkillDescriptiongetSkillDescription (const skills::SkillID &id)
 
std::map< skills::SkillID, skills::SkillDescriptiongetSkillDescriptions ()
 
std::optional< skills::SkillStatusUpdategetSkillExecutionStatus (const skills::SkillExecutionID &id)
 
std::map< skills::SkillExecutionID, skills::SkillStatusUpdategetSkillExecutionStatuses ()
 
void postCreatePropertyDefinitions (PropertyDefinitionsPtr &properties) override
 
void preOnConnectComponent () override
 
void preOnInitComponent () override
 
void removeProvider (const skills::ProviderID &id)
 
bool updateSkillParameters (const skills::SkillExecutionID &id, const aron::data::DictPtr &data)
 
- Public Member Functions inherited from ManagedIceObjectPlugin
ManagedIceObjectparent ()
 
template<class T >
Tparent ()
 
const ManagedIceObjectparent () const
 
template<class T >
const Tparent () const
 
template<class T >
bool parentDerives () const
 
virtual ~ManagedIceObjectPlugin ()=default
 

Protected Member Functions

skills::ProviderID getFirstProviderNameThatHasSkill (const skills::SkillID &skillid)
 
- Protected Member Functions inherited from ComponentPlugin
virtual void componentPropertiesUpdated (const std::set< std::string > &changedProperties)
 
 ManagedIceObjectPlugin (ManagedIceObject &parent, std::string pre)
 
- Protected Member Functions inherited from ManagedIceObjectPlugin
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)
 
void addPluginDependency (ManagedIceObjectPlugin *dependedOn)
 
void addPluginDependency (std::experimental::observer_ptr< ManagedIceObjectPlugin > dependedOn)
 
std::string makePropertyName (const std::string &name)
 
 ManagedIceObjectPlugin (ManagedIceObject &parent, std::string pre)
 
virtual void postOnConnectComponent ()
 
virtual void postOnDisconnectComponent ()
 
virtual void postOnExitComponent ()
 
virtual void postOnInitComponent ()
 
const std::string & prefix () const
 
virtual void preOnDisconnectComponent ()
 
virtual void preOnExitComponent ()
 

Friends

class armarx::SkillManagerComponentPluginUser
 

Detailed Description

Definition at line 24 of file SkillManagerComponentPlugin.h.

Member Function Documentation

◆ abortSkill()

bool abortSkill ( const skills::SkillExecutionID id)

Definition at line 268 of file SkillManagerComponentPlugin.cpp.

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

◆ abortSkillAsync()

bool abortSkillAsync ( const skills::SkillExecutionID id)

Definition at line 313 of file SkillManagerComponentPlugin.cpp.

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

◆ addProvider()

void addProvider ( const skills::ProviderInfo info)

Definition at line 49 of file SkillManagerComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ executeSkill()

Definition at line 85 of file SkillManagerComponentPlugin.cpp.

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

◆ executeSkillAsync()

skills::SkillExecutionID executeSkillAsync ( const skills::SkillExecutionRequest req)

Definition at line 152 of file SkillManagerComponentPlugin.cpp.

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

◆ getFirstProviderNameThatHasSkill()

skills::ProviderID getFirstProviderNameThatHasSkill ( const skills::SkillID skillid)
protected

Definition at line 31 of file SkillManagerComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ getSkillDescription()

std::optional< skills::SkillDescription > getSkillDescription ( const skills::SkillID id)

Definition at line 352 of file SkillManagerComponentPlugin.cpp.

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

◆ getSkillDescriptions()

std::map< skills::SkillID, skills::SkillDescription > getSkillDescriptions ( )

Definition at line 405 of file SkillManagerComponentPlugin.cpp.

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

◆ getSkillExecutionStatus()

std::optional< skills::SkillStatusUpdate > getSkillExecutionStatus ( const skills::SkillExecutionID id)

Definition at line 448 of file SkillManagerComponentPlugin.cpp.

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

◆ getSkillExecutionStatuses()

std::map< skills::SkillExecutionID, skills::SkillStatusUpdate > getSkillExecutionStatuses ( )

Definition at line 504 of file SkillManagerComponentPlugin.cpp.

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

◆ postCreatePropertyDefinitions()

void postCreatePropertyDefinitions ( PropertyDefinitionsPtr properties)
overridevirtual

Reimplemented from ComponentPlugin.

Definition at line 26 of file SkillManagerComponentPlugin.cpp.

◆ preOnConnectComponent()

void preOnConnectComponent ( )
overridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 19 of file SkillManagerComponentPlugin.cpp.

◆ preOnInitComponent()

void preOnInitComponent ( )
overridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 14 of file SkillManagerComponentPlugin.cpp.

◆ removeProvider()

void removeProvider ( const skills::ProviderID id)

Definition at line 69 of file SkillManagerComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ updateSkillParameters()

bool updateSkillParameters ( const skills::SkillExecutionID id,
const aron::data::DictPtr data 
)

Definition at line 221 of file SkillManagerComponentPlugin.cpp.

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

Friends And Related Function Documentation

◆ armarx::SkillManagerComponentPluginUser

Definition at line 76 of file SkillManagerComponentPlugin.h.


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