FluxioExecutor Class Reference

#include <RobotAPI/libraries/skills/core/executor/FluxioExecutor.h>

+ Inheritance diagram for FluxioExecutor:

Public Member Functions

virtual void abort ()
 
armarx::aron::data::VariantPtr findParameterValue (const std::experimental::observer_ptr< const FluxioProfile > profilePtr, const FluxioParameter &parameter) const
 
 FluxioExecutor (const FluxioExecutor &)=delete
 
 FluxioExecutor (const std::string &id, bool native)
 
virtual armarx::aron::data::VariantPtr getPossibleInputCopy (const std::string nodeId, const std::string parameterId)
 
virtual armarx::aron::data::DictPtr getResultsCopy ()
 
std::optional< skills::FluxioSkillStatusUpdategetStatus () const
 
virtual std::optional< std::vector< skills::FluxioSkillStatusUpdate > > getStatusUpdate ()
 
FluxioExecutoroperator= (const FluxioExecutor &)=delete
 
virtual void run (const std::string executorName, armarx::aron::data::DictPtr parameters, const std::experimental::observer_ptr< const FluxioProfile > profilePtr)
 
virtual ~FluxioExecutor ()
 

Public Attributes

const std::string id
 
const bool native
 

Protected Member Functions

virtual void setStatus (skills::SkillStatus status, const std::string &nodeId="noId")
 

Protected Attributes

std::optional< std::string > executorName = std::nullopt
 
std::map< std::string, armarx::aron::data::DictPtrpossibleInputs = {}
 
std::shared_mutex possibleInputsMutex
 
armarx::aron::data::DictPtr result = nullptr
 
std::shared_mutex resultMutex
 
std::optional< skills::FluxioSkillStatusUpdatestatus = std::nullopt
 
std::shared_mutex statusMutex
 
std::list< skills::FluxioSkillStatusUpdatestatusUpdates
 
std::shared_mutex statusUpdatesMutex
 

Detailed Description

Definition at line 21 of file FluxioExecutor.h.

Constructor & Destructor Documentation

◆ ~FluxioExecutor()

virtual ~FluxioExecutor ( )
inlinevirtual

Definition at line 24 of file FluxioExecutor.h.

◆ FluxioExecutor() [1/2]

FluxioExecutor ( const FluxioExecutor )
delete

◆ FluxioExecutor() [2/2]

FluxioExecutor ( const std::string &  id,
bool  native 
)
inline

Definition at line 30 of file FluxioExecutor.h.

Member Function Documentation

◆ abort()

virtual void abort ( )
inlinevirtual

Reimplemented in FluxioCompositeExecutor, FluxioNativeExecutor, and FluxioMergerExecutor.

Definition at line 34 of file FluxioExecutor.h.

◆ findParameterValue()

armarx::aron::data::VariantPtr findParameterValue ( const std::experimental::observer_ptr< const FluxioProfile profilePtr,
const FluxioParameter parameter 
) const

Definition at line 75 of file FluxioExecutor.cpp.

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

◆ getPossibleInputCopy()

armarx::aron::data::VariantPtr getPossibleInputCopy ( const std::string  nodeId,
const std::string  parameterId 
)
virtual

Definition at line 28 of file FluxioExecutor.cpp.

◆ getResultsCopy()

armarx::aron::data::DictPtr getResultsCopy ( )
virtual

Reimplemented in FluxioNativeExecutor.

Definition at line 51 of file FluxioExecutor.cpp.

◆ getStatus()

std::optional< skills::FluxioSkillStatusUpdate > getStatus ( ) const

Definition at line 69 of file FluxioExecutor.cpp.

◆ getStatusUpdate()

std::optional< std::vector< skills::FluxioSkillStatusUpdate > > getStatusUpdate ( )
virtual

Reimplemented in FluxioCompositeExecutor, FluxioNativeExecutor, and FluxioMergerExecutor.

Definition at line 63 of file FluxioExecutor.cpp.

◆ operator=()

FluxioExecutor& operator= ( const FluxioExecutor )
delete

◆ run()

virtual void run ( const std::string  executorName,
armarx::aron::data::DictPtr  parameters,
const std::experimental::observer_ptr< const FluxioProfile profilePtr 
)
inlinevirtual

Reimplemented in FluxioCompositeExecutor, FluxioNativeExecutor, and FluxioMergerExecutor.

Definition at line 31 of file FluxioExecutor.h.

◆ setStatus()

void setStatus ( skills::SkillStatus  status,
const std::string &  nodeId = "noId" 
)
protectedvirtual

Definition at line 17 of file FluxioExecutor.cpp.

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

Member Data Documentation

◆ executorName

std::optional<std::string> executorName = std::nullopt
protected

Definition at line 51 of file FluxioExecutor.h.

◆ id

const std::string id

Definition at line 47 of file FluxioExecutor.h.

◆ native

const bool native

Definition at line 48 of file FluxioExecutor.h.

◆ possibleInputs

std::map<std::string, armarx::aron::data::DictPtr> possibleInputs = {}
protected

Definition at line 59 of file FluxioExecutor.h.

◆ possibleInputsMutex

std::shared_mutex possibleInputsMutex
protected

Definition at line 60 of file FluxioExecutor.h.

◆ result

armarx::aron::data::DictPtr result = nullptr
protected

Definition at line 56 of file FluxioExecutor.h.

◆ resultMutex

std::shared_mutex resultMutex
protected

Definition at line 57 of file FluxioExecutor.h.

◆ status

std::optional<skills::FluxioSkillStatusUpdate> status = std::nullopt
protected

Definition at line 62 of file FluxioExecutor.h.

◆ statusMutex

std::shared_mutex statusMutex
protected

Definition at line 63 of file FluxioExecutor.h.

◆ statusUpdates

std::list<skills::FluxioSkillStatusUpdate> statusUpdates
protected

Definition at line 53 of file FluxioExecutor.h.

◆ statusUpdatesMutex

std::shared_mutex statusUpdatesMutex
protected

Definition at line 54 of file FluxioExecutor.h.


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