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
FluxioSkill &	operator= (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::DictPtr >	toAronDTO () 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::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 std::unique_ptr< skills::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 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 std::experimental::observer_ptr< const FluxioSkill >	FromFluxioIdentificatorAron (const manager::arondto::FluxioIdentificator &i, std::map< std::string, FluxioSkill > &skillsMap)
static std::experimental::observer_ptr< const FluxioSkill >	FromFluxioIdentificatorIce (const manager::dto::FluxioIdentificator &i, std::map< std::string, FluxioSkill > &skillsMap)
static 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)

Public Attributes
std::string	description
std::list< FluxioEdge >	edges
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, FluxioParameter >	parameters
std::experimental::observer_ptr< const FluxioProvider >	skillProviderPtr
armarx::Duration	timeout = armarx::Duration::MilliSeconds(-1)
	How long (in ms) to wait for the skill to finish execution before timing out.

Constructor & Destructor Documentation

FluxioSkill() [1/3]

FluxioSkill ( const FluxioSkill & )

delete

FluxioSkill() [2/3]

FluxioSkill ( FluxioSkill && )

default

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

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

deleteParameter()

void deleteParameter

(

const std::string &

parameterId

)

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

FromFluxioIdentificatorAron()

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

static

FromFluxioIdentificatorIce()

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

static

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

operator=()

FluxioSkill & operator= ( const FluxioSkill & )

delete

removeEdgesConnectedToParameter()

void removeEdgesConnectedToParameter

(

const std::string &

parameterId

)

removeParameterNodesAndEdges()

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

removeSubSkillNodesAndEdges()

void removeSubSkillNodesAndEdges

(

const std::string &

skillId

)

toAronDTO()

std::optional< aron::data::dto::DictPtr > toAronDTO

(

)

const

toAronXml()

std::optional< manager::arondto::FluxioSkill > toAronXml

(

)

const

toFluxioIdentificatorAron()

manager::arondto::FluxioIdentificator toFluxioIdentificatorAron

(

)

const

toFluxioIdentificatorIce()

manager::dto::FluxioIdentificator toFluxioIdentificatorIce

(

)

const

toManagerIce()

std::optional< manager::dto::FluxioSkill > toManagerIce

(

)

const

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 )

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 )

Member Data Documentation

description

std::string description

edges

std::list<FluxioEdge> edges

executable

bool executable

Initial value:

=
                false

id

std::string id

lastChanged

std::string lastChanged

name

std::string name

native

bool native = true

nodes

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

parameters

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

skillProviderPtr

std::experimental::observer_ptr<const FluxioProvider> skillProviderPtr

timeout

armarx::Duration timeout = armarx::Duration::MilliSeconds(-1)

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

A negative value indicates no timeout (default).

---

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

• RobotAPI/libraries/skills/core/FluxioSkill.h
• RobotAPI/libraries/skills/core/FluxioSkill.cpp