SkillManagerWrapper Class Reference

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

Inheritance diagram for SkillManagerWrapper:

Classes
struct	Snapshot

Public Slots
void	acceptSearchRequest (std::string const &search)
	Applies the search word to the update filter.
void	addParametersToHistory (const skills::SkillID &sid, const Parameters &params)
void	disconnectMemory ()
	Disconnects the interface from memory.
std::optional< Parameters >	getLatestParametersForSkill (const skills::SkillID &sid)
std::vector< Parameters >	getParameterHistoryForSkill (const skills::SkillID &sid)
void	stopAllExecutions ()
	Stops all available (and running) executions.
void	updateFromMemory ()
	Requests this wrapper to overwrite its own state from memory.

Signals
void	connectionUpdate (std::string const &message, std::string const &error)
void	disableAutoUpdate ()
void	searchAccepted ()
void	updateAvailable (Snapshot update)

Public Member Functions
void	connectMemory (skills::manager::dti::SkillManagerInterfacePrx const &updatedMemory)
	Updates the memory pointer.
StatusMap	getExecutions ()
	Returns the latest status snapshot.
SkillMap	getSkills ()
	Returns the latest skills snapshot.
SkillMap	getSkillsFiltered ()
	Returns the latest skills snapshot.
	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.
void	stopExecution (skills::SkillExecutionID const &executionId, const unsigned int max_retries=0)
	Attempts to stop an execution.

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

Constructor & Destructor Documentation

SkillManagerWrapper() [1/2]

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

inline

SkillManagerWrapper() [2/2]

SkillManagerWrapper ( QObject * parent = nullptr )

inline

Member Function Documentation

acceptSearchRequest

void acceptSearchRequest ( std::string const & search )

slot

Applies the search word to the update filter.

Parameters

search

The search word.

addParametersToHistory

void addParametersToHistory ( const skills::SkillID & sid, const Parameters & params )

slot

connectionUpdate

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

signal

connectMemory()

void connectMemory

(

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

updatedMemory

)

Updates the memory pointer.

This should be called whenever the GUI connects/reconnects.

disableAutoUpdate

void disableAutoUpdate ( )

signal

disconnectMemory

void disconnectMemory ( )

slot

Disconnects the interface from memory.

findFirstProvider()

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

static

getExecutions()

StatusMap getExecutions

(

)

Returns the latest status snapshot.

Returns

The map containing status updates for all execution ids.

getLatestParametersForSkill

std::optional< Parameters > getLatestParametersForSkill ( const skills::SkillID & sid )

slot

getParameterHistoryForSkill

std::vector< Parameters > getParameterHistoryForSkill ( const skills::SkillID & sid )

slot

getSkills()

SkillMap getSkills

(

)

Returns the latest skills snapshot.

Returns

The map representing all currently known skills.

getSkillsFiltered()

SkillMap getSkillsFiltered

(

)

Returns the latest skills snapshot.

Returns

The map representing all currently known skills.

searchAccepted

void searchAccepted ( )

signal

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.

stopAllExecutions

void stopAllExecutions ( )

slot

Stops all available (and running) executions.

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.

updateAvailable

void updateAvailable ( Snapshot update )

signal

updateFromMemory

void updateFromMemory ( )

slot

Requests this wrapper to overwrite its own state from memory.

---

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