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 () const
	SkillProxy ()=delete
	We remove the default constructor as every skill proxy requires a manager.
	SkillProxy (const manager::dti::SkillManagerInterfacePrx &manager, const SkillDescription &skillDesc)
	set the proxy using a skill description
	SkillProxy (const manager::dti::SkillManagerInterfacePrx &manager, const SkillID &skillId)
	set the skill proxy using a skillId. Queries the manager to get the description.
	SkillProxy (const SkillProxy &)=delete
	copy ctor
Public Member Functions inherited from SkillProxy
bool	abortSkill (const SkillExecutionID &executionId) const
	ask skill to abort ASAP. Blocks until skill stopped
bool	abortSkillAsync (const SkillExecutionID &executionId) const
	ask skill to abort ASAP
TerminatedSkillStatusUpdate	executeSkill (const std::string &executorName, const aron::data::DictPtr &params=nullptr) const
	execute a skill and block until skill terminates
SkillExecutionID	executeSkillAsync (const std::string &executorName, const aron::data::DictPtr &params=nullptr) const
	execute a skill. Do not block during execution
std::optional< SkillStatusUpdate >	getExecutionStatus (const SkillExecutionID &executionId) const
aron::data::DictPtr	getRootProfileParameters () const
	get the default parameters of the skill. TODO: Skill profiles in memory!
SkillDescription	getSkillDescription () const
	get the skill description
SkillID	getSkillId () const
	get the skill id from the skill description
std::optional< TerminatedSkillStatusUpdate >	join (const SkillExecutionID &executionId, armarx::Duration max_wait_time=armarx::Duration::Seconds(1), armarx::Frequency check_frequency=armarx::Frequency::Hertz(20)) const
	poll execution status and block until its null or terminated
SkillProxy &	operator= (const SkillProxy &)=delete
	SkillProxy ()=delete
	We remove the default constructor as every skill proxy requires a manager.
	SkillProxy (const manager::dti::SkillManagerInterfacePrx &manager, const SkillDescription &skillDesc)
	set the proxy using a skill description
	SkillProxy (const manager::dti::SkillManagerInterfacePrx &manager, const SkillID &skillId)
	set the skill proxy using a skillId. Queries the manager to get the description.
	SkillProxy (const SkillProxy &)=delete
	copy ctor
void	updateSubSkillStatus (const skills::SkillStatusUpdate &statusUpdate)
	~SkillProxy ()
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.
MessageTypeT	getEffectiveLoggingLevel () const
	Logging ()
void	setLocalMinimumLoggingLevel (MessageTypeT level)
	With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set.
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 LogSenderPtr &	getLogSender () const
	Retrieve log sender.
LogSenderPtr	loghelper (const char *file, int line, const char *function) const
Protected Attributes inherited from SkillProxy
SkillUpdateManager::CallbackID	callbackId
std::unordered_map< std::string, SkillStatusUpdate >	lastUpdates
std::mutex	lastUpdatesMutex
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()

template<class AronT>

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

template<class AronT>

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

template<class AronT>

AronT getRootProfileParameters ( ) const

inline

Definition at line 30 of file SpecializedSkillProxy.h.

Here is the call graph for this function:

SkillProxy() [1/4]

template<class AronT>

SkillProxy ( )

delete

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

SkillProxy() [2/4]

template<class AronT>

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

set the proxy using a skill description

Definition at line 78 of file SkillProxy.cpp.

SkillProxy() [3/4]

template<class AronT>

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 74 of file SkillProxy.cpp.

SkillProxy() [4/4]

template<class AronT>

SkillProxy ( const SkillProxy & )

delete

copy ctor

---

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

• RobotAPI/libraries/skills/provider/SpecializedSkillProxy.h