SkillProxy Class Reference

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

+ Inheritance diagram for SkillProxy:

Public Member Functions

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 ()
 

Protected Attributes

manager::dti::SkillManagerInterfacePrx manager
 
SkillDescription skillDescription
 
- Protected Attributes inherited from Logging
MessageTypeT minimumLoggingLevel
 
SpamFilterDataPtr spamFilter
 
LogTag tag
 

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
 

Detailed Description

Definition at line 11 of file SkillProxy.h.

Constructor & Destructor Documentation

◆ SkillProxy() [1/4]

SkillProxy ( )
delete

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

◆ SkillProxy() [2/4]

SkillProxy ( const manager::dti::SkillManagerInterfacePrx &  manager,
const SkillID skillId 
)

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

Definition at line 10 of file SkillProxy.cpp.

+ Here is the call graph for this function:

◆ SkillProxy() [3/4]

SkillProxy ( const manager::dti::SkillManagerInterfacePrx &  manager,
const SkillDescription skillDesc 
)

set the proxy using a skill description

Definition at line 30 of file SkillProxy.cpp.

+ Here is the call graph for this function:

◆ SkillProxy() [4/4]

SkillProxy ( const SkillProxy o)
default

copy ctor

Member Function Documentation

◆ abortSkill()

bool abortSkill ( const SkillExecutionID executionId) const

ask skill to abort ASAP. Blocks until skill stopped

Definition at line 107 of file SkillProxy.cpp.

◆ abortSkillAsync()

bool abortSkillAsync ( const SkillExecutionID executionId) const

ask skill to abort ASAP

Definition at line 115 of file SkillProxy.cpp.

◆ executeSkill()

TerminatedSkillStatusUpdate executeSkill ( const std::string &  executorName,
const aron::data::DictPtr params = nullptr 
) const

execute a skill and block until skill terminates

Definition at line 51 of file SkillProxy.cpp.

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

◆ executeSkillAsync()

SkillExecutionID executeSkillAsync ( const std::string &  executorName,
const aron::data::DictPtr params = nullptr 
) const

execute a skill. Do not block during execution

Definition at line 65 of file SkillProxy.cpp.

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

◆ getRootProfileParameters()

aron::data::DictPtr getRootProfileParameters ( ) const

get the default parameters of the skill. TODO: Skill profiles in memory!

Definition at line 123 of file SkillProxy.cpp.

+ Here is the caller graph for this function:

◆ getSkillDescription()

SkillDescription getSkillDescription ( ) const

get the skill description

Definition at line 39 of file SkillProxy.cpp.

◆ getSkillId()

SkillID getSkillId ( ) const

get the skill id from the skill description

Definition at line 45 of file SkillProxy.cpp.

◆ join()

std::optional< TerminatedSkillStatusUpdate > join ( const SkillExecutionID executionId) const

poll execution status and block until its null or terminated

Definition at line 79 of file SkillProxy.cpp.

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

Member Data Documentation

◆ manager

manager::dti::SkillManagerInterfacePrx manager
protected

Definition at line 59 of file SkillProxy.h.

◆ skillDescription

SkillDescription skillDescription
protected

Definition at line 60 of file SkillProxy.h.


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