SkillProviderComponentPlugin Class Reference

#include <RobotAPI/libraries/skills/provider/SkillProviderComponentPlugin.h>

+ Inheritance diagram for SkillProviderComponentPlugin:

Public Member Functions

bool abortSkill (const skills::SkillExecutionID &execId)
 
bool abortSkillAsync (const skills::SkillExecutionID &execId)
 
template<typename FactoryT , typename... Args>
requires skills::isSkillBlueprint< FactoryT > FactoryT * addCustomSkillFactory (Args &&... args)
 
template<class SkillT , typename... Args>
requires skills::isSkill< SkillT > skills::SkillBlueprintaddSkillFactory (Args &&... args)
 
skills::SkillBlueprintaddSkillFactory (const skills::SkillDescription &, const skills::LambdaSkill::FunctionType &)
 
void addSkillFactory (std::unique_ptr< skills::SkillBlueprint > &&)
 
skills::SkillStatusUpdate executeSkill (const skills::SkillExecutionRequest &executionInfo)
 
skills::SkillExecutionID executeSkillAsync (const skills::SkillExecutionRequest &executionInfo)
 
std::optional< skills::SkillDescriptiongetSkillDescription (const skills::SkillID &) const
 
std::map< skills::SkillID, skills::SkillDescriptiongetSkillDescriptions () const
 
std::optional< skills::SkillStatusUpdategetSkillExecutionStatus (const skills::SkillExecutionID &) const
 
std::map< skills::SkillExecutionID, skills::SkillStatusUpdategetSkillExecutionStatuses () const
 
void postCreatePropertyDefinitions (PropertyDefinitionsPtr &properties) override
 
void postOnConnectComponent () override
 
void preOnConnectComponent () override
 
void preOnDisconnectComponent () override
 
void preOnInitComponent () override
 
bool updateSkillParameters (const skills::SkillExecutionID &id, const armarx::aron::data::DictPtr &params)
 
- 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
 

Friends

class armarx::SkillProviderComponentPluginUser
 

Additional Inherited Members

- 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 postOnDisconnectComponent ()
 
virtual void postOnExitComponent ()
 
virtual void postOnInitComponent ()
 
const std::string & prefix () const
 
virtual void preOnExitComponent ()
 

Detailed Description

Definition at line 38 of file SkillProviderComponentPlugin.h.

Member Function Documentation

◆ abortSkill()

bool abortSkill ( const skills::SkillExecutionID execId)

Definition at line 354 of file SkillProviderComponentPlugin.cpp.

+ Here is the call graph for this function:

◆ abortSkillAsync()

bool abortSkillAsync ( const skills::SkillExecutionID execId)

Definition at line 388 of file SkillProviderComponentPlugin.cpp.

+ Here is the call graph for this function:

◆ addCustomSkillFactory()

requires skills::isSkillBlueprint<FactoryT> FactoryT* addCustomSkillFactory ( Args &&...  args)
inline

Definition at line 71 of file SkillProviderComponentPlugin.h.

+ Here is the call graph for this function:

◆ addSkillFactory() [1/3]

requires skills::isSkill<SkillT> skills::SkillBlueprint* addSkillFactory ( Args &&...  args)
inline

Definition at line 60 of file SkillProviderComponentPlugin.h.

+ Here is the call graph for this function:

◆ addSkillFactory() [2/3]

skills::SkillBlueprint * addSkillFactory ( const skills::SkillDescription desc,
const skills::LambdaSkill::FunctionType f 
)

Definition at line 96 of file SkillProviderComponentPlugin.cpp.

◆ addSkillFactory() [3/3]

void addSkillFactory ( std::unique_ptr< skills::SkillBlueprint > &&  fac)

Definition at line 59 of file SkillProviderComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ executeSkill()

skills::SkillStatusUpdate executeSkill ( const skills::SkillExecutionRequest executionInfo)

Definition at line 189 of file SkillProviderComponentPlugin.cpp.

+ Here is the call graph for this function:

◆ executeSkillAsync()

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

Definition at line 255 of file SkillProviderComponentPlugin.cpp.

+ Here is the call graph for this function:

◆ getSkillDescription()

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

Definition at line 151 of file SkillProviderComponentPlugin.cpp.

+ Here is the call graph for this function:

◆ getSkillDescriptions()

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

Definition at line 176 of file SkillProviderComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ getSkillExecutionStatus()

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

Definition at line 119 of file SkillProviderComponentPlugin.cpp.

+ Here is the call graph for this function:

◆ getSkillExecutionStatuses()

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

Definition at line 137 of file SkillProviderComponentPlugin.cpp.

◆ postCreatePropertyDefinitions()

void postCreatePropertyDefinitions ( PropertyDefinitionsPtr properties)
overridevirtual

Reimplemented from ComponentPlugin.

Definition at line 48 of file SkillProviderComponentPlugin.cpp.

+ Here is the call graph for this function:

◆ postOnConnectComponent()

void postOnConnectComponent ( )
overridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 23 of file SkillProviderComponentPlugin.cpp.

+ Here is the call graph for this function:

◆ preOnConnectComponent()

void preOnConnectComponent ( )
overridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 16 of file SkillProviderComponentPlugin.cpp.

◆ preOnDisconnectComponent()

void preOnDisconnectComponent ( )
overridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 38 of file SkillProviderComponentPlugin.cpp.

◆ preOnInitComponent()

void preOnInitComponent ( )
overridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 11 of file SkillProviderComponentPlugin.cpp.

◆ updateSkillParameters()

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

Definition at line 327 of file SkillProviderComponentPlugin.cpp.

+ Here is the call graph for this function:

Friends And Related Function Documentation

◆ armarx::SkillProviderComponentPluginUser

Definition at line 113 of file SkillProviderComponentPlugin.h.


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