FluxioSkill Struct Reference

#include <RobotAPI/libraries/skills/core/FluxioSkill.h>

Public Member Functions

void deleteParameter (const std::string &parameterId)
 
 FluxioSkill ()=default
 
 FluxioSkill (const FluxioSkill &)=delete
 
 FluxioSkill (FluxioSkill &&)=default
 
FluxioSkilloperator= (const FluxioSkill &)=delete
 
void removeEdgesConnectedToParameter (const std::string &parameterId)
 
void removeParameterNodesAndEdges (const std::string &parameterId, bool keepParameterNodes=false)
 
void removeSubSkillNodesAndEdges (const std::string &skillId)
 
std::optional< aron::data::dto::DictPtrtoAronDTO () const
 
std::optional< manager::arondto::FluxioSkill > toAronXml () const
 
manager::arondto::FluxioIdentificator toFluxioIdentificatorAron () const
 
manager::dto::FluxioIdentificator toFluxioIdentificatorIce () const
 
std::optional< manager::dto::FluxioSkill > toManagerIce () const
 
bool updateFromAron (const aron::data::dto::DictPtr &i, std::map< std::string, FluxioProvider > &providersMap, std::map< std::string, FluxioProfile > &profilesMap, std::map< std::string, FluxioSkill > &skillsMap, std::map< std::string, aron::type::ObjectPtr > &typesMap)
 
bool updateFromIce (const manager::dto::FluxioSkill &i, std::map< std::string, FluxioProvider > &providersMap, std::map< std::string, FluxioProfile > &profilesMap, std::map< std::string, FluxioSkill > &skillsMap, std::map< std::string, aron::type::ObjectPtr > &typesMap)
 

Static Public Member Functions

static std::unique_ptr< skills::FluxioNodeCreateNode (const manager::arondto::FluxioNode &i, std::map< std::string, FluxioParameter > &parametersMap, std::map< std::string, FluxioSkill > &skillsMap, std::map< std::string, FluxioProfile > &profilesMap, std::map< std::string, aron::type::ObjectPtr > &typesMap, std::map< const std::string, const std::unique_ptr< FluxioNode > > &nodesMap)
 
static std::unique_ptr< skills::FluxioNodeCreateNode (const manager::dto::FluxioNode &i, std::map< std::string, FluxioParameter > &parametersMap, std::map< std::string, FluxioSkill > &skillsMap, std::map< std::string, FluxioProfile > &profilesMap, std::map< std::string, aron::type::ObjectPtr > &typesMap, std::map< const std::string, const std::unique_ptr< FluxioNode > > &nodesMap)
 
static std::unique_ptr< FluxioSkillFromAron (const aron::data::dto::DictPtr &d, std::map< std::string, FluxioProvider > &providersMap, std::map< std::string, FluxioProfile > &profilesMap, std::map< std::string, FluxioSkill > &skillsMap, std::map< std::string, aron::type::ObjectPtr > &typesMap)
 
static std::experimental::observer_ptr< const FluxioSkillFromFluxioIdentificatorAron (const manager::arondto::FluxioIdentificator &i, std::map< std::string, FluxioSkill > &skillsMap)
 
static std::experimental::observer_ptr< const FluxioSkillFromFluxioIdentificatorIce (const manager::dto::FluxioIdentificator &i, std::map< std::string, FluxioSkill > &skillsMap)
 
static std::unique_ptr< FluxioSkillFromIce (const manager::dto::FluxioSkill &i, std::map< std::string, FluxioProvider > &providersMap, std::map< std::string, FluxioProfile > &profilesMap, std::map< std::string, FluxioSkill > &skillsMap, std::map< std::string, aron::type::ObjectPtr > &typesMap)
 

Public Attributes

std::string description
 
std::list< FluxioEdgeedges
 
bool executable
 
std::string id
 
std::string lastChanged
 
std::string name
 
bool native = true
 
std::map< const std::string, const std::unique_ptr< FluxioNode > > nodes
 
std::map< std::string, FluxioParameterparameters
 
std::experimental::observer_ptr< const FluxioProviderskillProviderPtr
 
armarx::Duration timeout = armarx::Duration::MilliSeconds(-1)
 How long (in ms) to wait for the skill to finish execution before timing out.
 

Detailed Description

Definition at line 25 of file FluxioSkill.h.

Constructor & Destructor Documentation

◆ FluxioSkill() [1/3]

FluxioSkill ( const FluxioSkill & )
delete
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ FluxioSkill() [2/3]

FluxioSkill ( FluxioSkill && )
default
+ Here is the call graph for this function:

◆ FluxioSkill() [3/3]

FluxioSkill ( )
default

Member Function Documentation

◆ CreateNode() [1/2]

std::unique_ptr< FluxioNode > CreateNode ( const manager::arondto::FluxioNode & i,
std::map< std::string, FluxioParameter > & parametersMap,
std::map< std::string, FluxioSkill > & skillsMap,
std::map< std::string, FluxioProfile > & profilesMap,
std::map< std::string, aron::type::ObjectPtr > & typesMap,
std::map< const std::string, const std::unique_ptr< FluxioNode > > & nodesMap )
static

Definition at line 787 of file FluxioSkill.cpp.

+ Here is the call graph for this function:

◆ CreateNode() [2/2]

std::unique_ptr< FluxioNode > CreateNode ( const manager::dto::FluxioNode & i,
std::map< std::string, FluxioParameter > & parametersMap,
std::map< std::string, FluxioSkill > & skillsMap,
std::map< std::string, FluxioProfile > & profilesMap,
std::map< std::string, aron::type::ObjectPtr > & typesMap,
std::map< const std::string, const std::unique_ptr< FluxioNode > > & nodesMap )
static

Definition at line 733 of file FluxioSkill.cpp.

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

◆ deleteParameter()

void deleteParameter ( const std::string & parameterId)

Definition at line 442 of file FluxioSkill.cpp.

+ Here is the call graph for this function:

◆ FromAron()

std::unique_ptr< FluxioSkill > FromAron ( const aron::data::dto::DictPtr & d,
std::map< std::string, FluxioProvider > & providersMap,
std::map< std::string, FluxioProfile > & profilesMap,
std::map< std::string, FluxioSkill > & skillsMap,
std::map< std::string, aron::type::ObjectPtr > & typesMap )
static

Definition at line 635 of file FluxioSkill.cpp.

+ Here is the call graph for this function:

◆ FromFluxioIdentificatorAron()

std::experimental::observer_ptr< const FluxioSkill > FromFluxioIdentificatorAron ( const manager::arondto::FluxioIdentificator & i,
std::map< std::string, FluxioSkill > & skillsMap )
static

Definition at line 532 of file FluxioSkill.cpp.

+ Here is the caller graph for this function:

◆ FromFluxioIdentificatorIce()

std::experimental::observer_ptr< const FluxioSkill > FromFluxioIdentificatorIce ( const manager::dto::FluxioIdentificator & i,
std::map< std::string, FluxioSkill > & skillsMap )
static

Definition at line 517 of file FluxioSkill.cpp.

+ Here is the caller graph for this function:

◆ FromIce()

std::unique_ptr< FluxioSkill > FromIce ( const manager::dto::FluxioSkill & i,
std::map< std::string, FluxioProvider > & providersMap,
std::map< std::string, FluxioProfile > & profilesMap,
std::map< std::string, FluxioSkill > & skillsMap,
std::map< std::string, aron::type::ObjectPtr > & typesMap )
static

Definition at line 547 of file FluxioSkill.cpp.

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

◆ operator=()

FluxioSkill & operator= ( const FluxioSkill & )
delete
+ Here is the call graph for this function:

◆ removeEdgesConnectedToParameter()

void removeEdgesConnectedToParameter ( const std::string & parameterId)

Definition at line 497 of file FluxioSkill.cpp.

◆ removeParameterNodesAndEdges()

void removeParameterNodesAndEdges ( const std::string & parameterId,
bool keepParameterNodes = false )

Definition at line 389 of file FluxioSkill.cpp.

+ Here is the caller graph for this function:

◆ removeSubSkillNodesAndEdges()

void removeSubSkillNodesAndEdges ( const std::string & skillId)

Definition at line 449 of file FluxioSkill.cpp.

◆ toAronDTO()

std::optional< aron::data::dto::DictPtr > toAronDTO ( ) const

Definition at line 914 of file FluxioSkill.cpp.

+ Here is the call graph for this function:

◆ toAronXml()

std::optional< manager::arondto::FluxioSkill > toAronXml ( ) const

Definition at line 841 of file FluxioSkill.cpp.

+ Here is the caller graph for this function:

◆ toFluxioIdentificatorAron()

manager::arondto::FluxioIdentificator toFluxioIdentificatorAron ( ) const

Definition at line 118 of file FluxioSkill.cpp.

◆ toFluxioIdentificatorIce()

manager::dto::FluxioIdentificator toFluxioIdentificatorIce ( ) const

Definition at line 107 of file FluxioSkill.cpp.

◆ toManagerIce()

std::optional< manager::dto::FluxioSkill > toManagerIce ( ) const

Definition at line 35 of file FluxioSkill.cpp.

+ Here is the call graph for this function:

◆ updateFromAron()

bool updateFromAron ( const aron::data::dto::DictPtr & i,
std::map< std::string, FluxioProvider > & providersMap,
std::map< std::string, FluxioProfile > & profilesMap,
std::map< std::string, FluxioSkill > & skillsMap,
std::map< std::string, aron::type::ObjectPtr > & typesMap )

Definition at line 254 of file FluxioSkill.cpp.

+ Here is the call graph for this function:

◆ updateFromIce()

bool updateFromIce ( const manager::dto::FluxioSkill & i,
std::map< std::string, FluxioProvider > & providersMap,
std::map< std::string, FluxioProfile > & profilesMap,
std::map< std::string, FluxioSkill > & skillsMap,
std::map< std::string, aron::type::ObjectPtr > & typesMap )

Definition at line 129 of file FluxioSkill.cpp.

+ Here is the call graph for this function:

Member Data Documentation

◆ description

std::string description

Definition at line 29 of file FluxioSkill.h.

◆ edges

std::list<FluxioEdge> edges

Definition at line 41 of file FluxioSkill.h.

◆ executable

bool executable
Initial value:
=
false

Definition at line 35 of file FluxioSkill.h.

◆ id

std::string id

Definition at line 27 of file FluxioSkill.h.

◆ lastChanged

std::string lastChanged

Definition at line 34 of file FluxioSkill.h.

◆ name

std::string name

Definition at line 28 of file FluxioSkill.h.

◆ native

bool native = true

Definition at line 37 of file FluxioSkill.h.

◆ nodes

std::map<const std::string, const std::unique_ptr<FluxioNode> > nodes

Definition at line 40 of file FluxioSkill.h.

◆ parameters

std::map<std::string, FluxioParameter> parameters

Definition at line 39 of file FluxioSkill.h.

◆ skillProviderPtr

Definition at line 38 of file FluxioSkill.h.

◆ timeout

How long (in ms) to wait for the skill to finish execution before timing out.

A negative value indicates no timeout (default).

Definition at line 33 of file FluxioSkill.h.


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