SpecializedSkillProxy< AronT > Class Template Reference

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

+ Inheritance diagram for SpecializedSkillProxy< AronT >:

Public Member Functions

TerminatedSkillStatusUpdate executeSkill (const std::string &executorName, const AronT &params)
 
SkillExecutionID executeSkillAsync (const std::string &executorName, const AronT &params=nullptr)
 
AronT getRootProfileParameters ()
 
 SkillProxy ()=delete
 We remove the default constructor as every skill proxy requires a manager. More...
 
 SkillProxy (const manager::dti::SkillManagerInterfacePrx &manager, const SkillDescription &skillDesc)
 set the proxy using a skill description More...
 
 SkillProxy (const manager::dti::SkillManagerInterfacePrx &manager, const SkillID &skillId)
 set the skill proxy using a skillId. Queries the manager to get the description. More...
 
 SkillProxy (const SkillProxy &o)=default
 copy ctor More...
 
- Public Member Functions inherited from SkillProxy
bool abortSkill (const SkillExecutionID &executionId) const
 ask skill to abort ASAP. Blocks until skill stopped More...
 
bool abortSkillAsync (const SkillExecutionID &executionId) const
 ask skill to abort ASAP More...
 
TerminatedSkillStatusUpdate executeSkill (const std::string &executorName, const aron::data::DictPtr &params=nullptr) const
 execute a skill and block until skill terminates More...
 
SkillExecutionID executeSkillAsync (const std::string &executorName, const aron::data::DictPtr &params=nullptr) const
 execute a skill. Do not block during execution More...
 
aron::data::DictPtr getRootProfileParameters () const
 get the default parameters of the skill. TODO: Skill profiles in memory! More...
 
SkillDescription getSkillDescription () const
 get the skill description More...
 
SkillID getSkillId () const
 get the skill id from the skill description More...
 
std::optional< TerminatedSkillStatusUpdatejoin (const SkillExecutionID &executionId) const
 poll execution status and block until its null or terminated More...
 
 SkillProxy ()=delete
 We remove the default constructor as every skill proxy requires a manager. More...
 
 SkillProxy (const manager::dti::SkillManagerInterfacePrx &manager, const SkillDescription &skillDesc)
 set the proxy using a skill description More...
 
 SkillProxy (const manager::dti::SkillManagerInterfacePrx &manager, const SkillID &skillId)
 set the skill proxy using a skillId. Queries the manager to get the description. More...
 
 SkillProxy (const SkillProxy &o)=default
 copy ctor More...
 
- Public Member Functions inherited from Logging
SpamFilterDataPtr deactivateSpam (float deactivationDurationSec=10.0f, const std::string &identifier="", bool deactivate=true) const
 disables the logging for the current line for the given amount of seconds. More...
 
MessageTypeT getEffectiveLoggingLevel () const
 
 Logging ()
 
void setLocalMinimumLoggingLevel (MessageTypeT level)
 With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set. More...
 
void setTag (const LogTag &tag)
 
void setTag (const std::string &tagName)
 
virtual ~Logging ()
 

Additional Inherited Members

- Protected Member Functions inherited from Logging
bool checkLogLevel (MessageTypeT level) const
 
const LogSenderPtrgetLogSender () const
 Retrieve log sender. More...
 
LogSenderPtr loghelper (const char *file, int line, const char *function) const
 
- Protected Attributes inherited from SkillProxy
manager::dti::SkillManagerInterfacePrx manager
 
SkillDescription skillDescription
 
- Protected Attributes inherited from Logging
MessageTypeT minimumLoggingLevel
 
SpamFilterDataPtr spamFilter
 
LogTag tag
 

Detailed Description

template<class AronT>
class armarx::skills::SpecializedSkillProxy< AronT >

Definition at line 10 of file SpecializedSkillProxy.h.

Member Function Documentation

◆ executeSkill()

TerminatedSkillStatusUpdate executeSkill ( const std::string &  executorName,
const AronT &  params 
)
inline

Definition at line 17 of file SpecializedSkillProxy.h.

+ Here is the call graph for this function:

◆ executeSkillAsync()

SkillExecutionID executeSkillAsync ( const std::string &  executorName,
const AronT &  params = nullptr 
)
inline

Definition at line 23 of file SpecializedSkillProxy.h.

+ Here is the call graph for this function:

◆ getRootProfileParameters()

AronT getRootProfileParameters ( )
inline

Definition at line 30 of file SpecializedSkillProxy.h.

+ Here is the call graph for this function:

◆ SkillProxy() [1/4]

SkillProxy
delete

We remove the default constructor as every skill proxy requires a manager.

◆ SkillProxy() [2/4]

set the proxy using a skill description

Definition at line 30 of file SkillProxy.cpp.

◆ SkillProxy() [3/4]

set the skill proxy using a skillId. Queries the manager to get the description.

Definition at line 10 of file SkillProxy.cpp.

◆ SkillProxy() [4/4]

SkillProxy
default

copy ctor


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