SkillManagerWrapper Class Reference

#include <RobotAPI/libraries/skills_gui/memory/SkillManagerWrapper.h>

Inheritance diagram for SkillManagerWrapper:

Public Slots
void	acceptSearchRequest (std::string const &search)
	Applies the search word to the update filter. More...
void	disconnectMemory ()
	Disconnects the interface from memory. More...
void	stopAllExecutions ()
	Stops all available (and running) executions. More...

Signals
void	connectionUpdate (std::string const &message, std::string const &error)

Public Member Functions
void	connectMemory (skills::manager::dti::SkillManagerInterfacePrx const &updatedMemory)
	Updates the memory pointer. More...
const StatusMap	fetchExecutions ()
	Fetches and returns the latest status update from memory. More...
const SkillMap	fetchSkills ()
	Fetches and returns the latest skills update from memory. More...
	SkillManagerWrapper (QObject *parent=nullptr)
	SkillManagerWrapper (skills::manager::dti::SkillManagerInterfacePrx &_memory, QObject *parent=nullptr)
void	startExecutionWithParams (skills::SkillID &skillId, aron::data::DictPtr const params)
	Attempts to start an execution with given parameters. More...
void	stopExecution (skills::SkillExecutionID const &executionId, const unsigned int max_retries=0)
	Attempts to stop an execution. More...

Static Public Member Functions
static const std::optional< skills::ProviderID >	findFirstProvider (SkillMap const &map, SkillID const &skillId)

Detailed Description

Definition at line 19 of file SkillManagerWrapper.h.

Constructor & Destructor Documentation

SkillManagerWrapper() [1/2]

SkillManagerWrapper ( skills::manager::dti::SkillManagerInterfacePrx &  _memory, QObject *  parent = nullptr  )

inline

Definition at line 23 of file SkillManagerWrapper.h.

SkillManagerWrapper() [2/2]

SkillManagerWrapper ( QObject *  parent = nullptr )

inline

Definition at line 30 of file SkillManagerWrapper.h.

Member Function Documentation

acceptSearchRequest

void acceptSearchRequest ( std::string const &  search )

slot

Applies the search word to the update filter.

Parameters

search

The search word.

Definition at line 179 of file SkillManagerWrapper.cpp.

connectionUpdate

void connectionUpdate ( std::string const &  message, std::string const &  error  )

signal

Here is the caller graph for this function:

connectMemory()

void connectMemory

(

skills::manager::dti::SkillManagerInterfacePrx const &

updatedMemory

)

Updates the memory pointer.

This should be called whenever the GUI connects/reconnects.

Definition at line 162 of file SkillManagerWrapper.cpp.

disconnectMemory

void disconnectMemory ( )

slot

Disconnects the interface from memory.

Definition at line 170 of file SkillManagerWrapper.cpp.

fetchExecutions()

const StatusMap fetchExecutions

(

)

Fetches and returns the latest status update from memory.

Returns

The map containing status updates for all execution ids. Empty, if error occurred.

Definition at line 14 of file SkillManagerWrapper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

fetchSkills()

const SkillMap fetchSkills

(

)

Fetches and returns the latest skills update from memory.

Returns

The map representing all skills in memory. Empty, if error occurred.

Definition at line 113 of file SkillManagerWrapper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

findFirstProvider()

const std::optional< ProviderID > findFirstProvider ( SkillMap const &  map, SkillID const &  skillId  )

static

Definition at line 201 of file SkillManagerWrapper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

startExecutionWithParams()

void startExecutionWithParams	(	skills::SkillID &	skillId,
		aron::data::DictPtr const	params
	)

Attempts to start an execution with given parameters.

If an Ice exception is encountered, a message will be logged and the method will abort.

Parameters

skillId	The skill to execute.
params	The parameters to execute with.

Definition at line 279 of file SkillManagerWrapper.cpp.

Here is the call graph for this function:

stopAllExecutions

void stopAllExecutions ( )

slot

Stops all available (and running) executions.

Definition at line 185 of file SkillManagerWrapper.cpp.

Here is the call graph for this function:

stopExecution()

void stopExecution	(	skills::SkillExecutionID const &	executionId,
		const unsigned int	max_retries = 0
	)

Attempts to stop an execution.

If this doesn't succeed, it will retry.

Parameters

executionId	The ExecutionID to abort.
max_retries	The amount of times to retry, if aborting fails.

Definition at line 225 of file SkillManagerWrapper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• RobotAPI/libraries/skills_gui/memory/SkillManagerWrapper.h
• RobotAPI/libraries/skills_gui/memory/SkillManagerWrapper.cpp