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

void abortFluxioSkill (const std::string &executionId)
 
skills::Result< std::experimental::observer_ptr< const skills::FluxioProvider >, skills::error::FluxioExceptionaddFluxioProvider (const std::string &name)
 
skills::Result< std::experimental::observer_ptr< const skills::FluxioSkill >, skills::error::FluxioExceptionaddSkillToProvider (const std::string &userId, const std::string &providerId, skills::FluxioSkill &&skill)
 
skills::Result< skills::FluxioProfile, skills::error::FluxioExceptioncreateProfile (const skills::FluxioProfile &profile)
 
std::optional< std::vector< std::experimental::observer_ptr< const skills::FluxioSkill > > > deleteSkill (const std::string &skillId, const std::string &userId, bool dryRun)
 
void deleteSkillMutex (const std::string &skillId, const std::string &userId)
 
skills::Result< std::vector< std::experimental::observer_ptr< const skills::FluxioSkill > >, skills::error::FluxioExceptiondeleteSkillParameter (const std::string &skillId, const std::string &parameterId, const std::string &userId, bool dryRun)
 
skills::Result< std::experimental::observer_ptr< skills::FluxioExecutor >, skills::error::FluxioExceptionexecuteFluxioSkill (const std::string &skillId, const std::string &profileId, const std::string &executorName, armarx::aron::data::DictPtr parameters=nullptr)
 
skills::ProviderID getFirstProviderNameThatHasSkill (const skills::SkillID &skillid)
 
skills::Result< std::vector< skills::FluxioSkillStatusUpdate >, skills::error::FluxioExceptiongetFluxioSkillExecutionStatus (const std::string &executionId)
 
skills::Result< skills::FluxioProfile, skills::error::FluxioExceptiongetProfile (const std::string &id)
 
skills::Result< std::vector< std::experimental::observer_ptr< const skills::FluxioProfile > >, skills::error::FluxioExceptiongetProfileList ()
 
skills::Result< skills::FluxioProvider, skills::error::FluxioExceptiongetProvider (const std::string &id)
 
skills::Result< std::vector< std::experimental::observer_ptr< const skills::FluxioProvider > >, skills::error::FluxioExceptiongetProviderList ()
 
skills::Result< std::experimental::observer_ptr< const skills::FluxioSkill >, skills::error::FluxioExceptiongetSkill (const std::string &id)
 
skills::Result< std::vector< std::experimental::observer_ptr< const skills::FluxioSkill > >, skills::error::FluxioExceptiongetSkillList ()
 
skills::Result< bool, skills::error::FluxioExceptiongetSkillMutex (const std::string &skillId, const std::string &userId)
 
skills::Result< std::vector< std::experimental::observer_ptr< const skills::FluxioSkill > >, skills::error::FluxioExceptiongetSkillsOfProvider (const std::string &id)
 
aron::type::ObjectPtr getTypes ()
 
void updateProfile (const skills::FluxioProfile &profile)
 
skills::Result< std::vector< std::experimental::observer_ptr< const skills::FluxioSkill > >, skills::error::FluxioExceptionupdateSkillParameter (const std::string &skillId, const skills::manager::dto::FluxioParameter &parameter, const std::string &userId, bool dryRun)
 
- 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 49 of file SkillManagerComponentPlugin.h.

Member Function Documentation

◆ abortFluxioSkill()

void abortFluxioSkill ( const std::string &  executionId)
protected

Definition at line 854 of file SkillManagerComponentPlugin.cpp.

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

◆ abortSkill()

bool abortSkill ( const skills::SkillExecutionID id)

Definition at line 356 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 401 of file SkillManagerComponentPlugin.cpp.

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

◆ addFluxioProvider()

skills::Result< std::experimental::observer_ptr< const skills::FluxioProvider >, skills::error::FluxioException > addFluxioProvider ( const std::string &  name)
protected

Definition at line 1625 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 133 of file SkillManagerComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ addSkillToProvider()

skills::Result< std::experimental::observer_ptr< const skills::FluxioSkill >, skills::error::FluxioException > addSkillToProvider ( const std::string &  userId,
const std::string &  providerId,
skills::FluxioSkill &&  skill 
)
protected

Definition at line 1738 of file SkillManagerComponentPlugin.cpp.

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

◆ createProfile()

Definition at line 1527 of file SkillManagerComponentPlugin.cpp.

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

◆ deleteSkill()

std::optional< std::vector< std::experimental::observer_ptr< const skills::FluxioSkill > > > deleteSkill ( const std::string &  skillId,
const std::string &  userId,
bool  dryRun 
)
protected

Definition at line 1163 of file SkillManagerComponentPlugin.cpp.

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

◆ deleteSkillMutex()

void deleteSkillMutex ( const std::string &  skillId,
const std::string &  userId 
)
protected

Definition at line 1488 of file SkillManagerComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ deleteSkillParameter()

skills::Result< std::vector< std::experimental::observer_ptr< const skills::FluxioSkill > >, skills::error::FluxioException > deleteSkillParameter ( const std::string &  skillId,
const std::string &  parameterId,
const std::string &  userId,
bool  dryRun 
)
protected

Definition at line 1295 of file SkillManagerComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ executeFluxioSkill()

skills::Result< std::experimental::observer_ptr< skills::FluxioExecutor >, skills::error::FluxioException > executeFluxioSkill ( const std::string &  skillId,
const std::string &  profileId,
const std::string &  executorName,
armarx::aron::data::DictPtr  parameters = nullptr 
)
protected

Definition at line 697 of file SkillManagerComponentPlugin.cpp.

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

◆ executeSkill()

Definition at line 175 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 241 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 115 of file SkillManagerComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ getFluxioSkillExecutionStatus()

skills::Result< std::vector< skills::FluxioSkillStatusUpdate >, skills::error::FluxioException > getFluxioSkillExecutionStatus ( const std::string &  executionId)
protected

Definition at line 878 of file SkillManagerComponentPlugin.cpp.

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

◆ getProfile()

skills::Result< skills::FluxioProfile, skills::error::FluxioException > getProfile ( const std::string &  id)
protected

Definition at line 1506 of file SkillManagerComponentPlugin.cpp.

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

◆ getProfileList()

Definition at line 1497 of file SkillManagerComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ getProvider()

skills::Result< skills::FluxioProvider, skills::error::FluxioException > getProvider ( const std::string &  id)
protected

Definition at line 1673 of file SkillManagerComponentPlugin.cpp.

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

◆ getProviderList()

Definition at line 1650 of file SkillManagerComponentPlugin.cpp.

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

◆ getSkill()

skills::Result< std::experimental::observer_ptr< const skills::FluxioSkill >, skills::error::FluxioException > getSkill ( const std::string &  id)
protected

Definition at line 1141 of file SkillManagerComponentPlugin.cpp.

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

◆ getSkillDescription()

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

Definition at line 444 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 499 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 547 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 605 of file SkillManagerComponentPlugin.cpp.

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

◆ getSkillList()

Definition at line 1134 of file SkillManagerComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ getSkillMutex()

skills::Result< bool, skills::error::FluxioException > getSkillMutex ( const std::string &  skillId,
const std::string &  userId 
)
protected

Definition at line 1481 of file SkillManagerComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ getSkillsOfProvider()

skills::Result< std::vector< std::experimental::observer_ptr< const skills::FluxioSkill > >, skills::error::FluxioException > getSkillsOfProvider ( const std::string &  id)
protected

Definition at line 1697 of file SkillManagerComponentPlugin.cpp.

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

◆ getTypes()

aron::type::ObjectPtr getTypes ( )
protected

Definition at line 1917 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 110 of file SkillManagerComponentPlugin.cpp.

◆ preOnConnectComponent()

void preOnConnectComponent ( )
overridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 103 of file SkillManagerComponentPlugin.cpp.

◆ preOnInitComponent()

void preOnInitComponent ( )
overridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 64 of file SkillManagerComponentPlugin.cpp.

◆ removeProvider()

void removeProvider ( const skills::ProviderID id)

Definition at line 159 of file SkillManagerComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ updateProfile()

void updateProfile ( const skills::FluxioProfile profile)
protected

Definition at line 1605 of file SkillManagerComponentPlugin.cpp.

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

◆ updateSkillParameter()

skills::Result< std::vector< std::experimental::observer_ptr< const skills::FluxioSkill > >, skills::error::FluxioException > updateSkillParameter ( const std::string &  skillId,
const skills::manager::dto::FluxioParameter &  parameter,
const std::string &  userId,
bool  dryRun 
)
protected

Definition at line 1305 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 309 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 245 of file SkillManagerComponentPlugin.h.


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