List of all members | Classes | Public Slots | Signals | Public Member Functions | Static Public Member Functions
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)
 

Detailed Description

Definition at line 25 of file SkillManagerWrapper.h.

Constructor & Destructor Documentation

◆ SkillManagerWrapper() [1/2]

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

Definition at line 29 of file SkillManagerWrapper.h.

◆ SkillManagerWrapper() [2/2]

SkillManagerWrapper ( QObject * parent = nullptr)
inline

Definition at line 36 of file SkillManagerWrapper.h.

Member Function Documentation

◆ acceptSearchRequest

void acceptSearchRequest ( std::string const & search)
slot

Applies the search word to the update filter.

Parameters
searchThe search word.

Definition at line 197 of file SkillManagerWrapper.cpp.

+ Here is the call graph for this function:

◆ addParametersToHistory

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

Definition at line 258 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 180 of file SkillManagerWrapper.cpp.

◆ disableAutoUpdate

void disableAutoUpdate ( )
signal

◆ disconnectMemory

void disconnectMemory ( )
slot

Disconnects the interface from memory.

Definition at line 188 of file SkillManagerWrapper.cpp.

◆ findFirstProvider()

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

Definition at line 286 of file SkillManagerWrapper.cpp.

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

◆ getExecutions()

StatusMap getExecutions ( )

Returns the latest status snapshot.

Returns
The map containing status updates for all execution ids.

Definition at line 328 of file SkillManagerWrapper.cpp.

+ Here is the caller graph for this function:

◆ getLatestParametersForSkill

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

Definition at line 275 of file SkillManagerWrapper.cpp.

+ Here is the call graph for this function:

◆ getParameterHistoryForSkill

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

Definition at line 247 of file SkillManagerWrapper.cpp.

+ Here is the caller graph for this function:

◆ getSkills()

SkillMap getSkills ( )

Returns the latest skills snapshot.

Returns
The map representing all currently known skills.

Definition at line 320 of file SkillManagerWrapper.cpp.

+ Here is the caller graph for this function:

◆ getSkillsFiltered()

SkillMap getSkillsFiltered ( )

Returns the latest skills snapshot.

Returns
The map representing all currently known skills.

Definition at line 310 of file SkillManagerWrapper.cpp.

◆ searchAccepted

void searchAccepted ( )
signal
+ 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
skillIdThe skill to execute.
paramsThe parameters to execute with.

Definition at line 390 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 204 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
executionIdThe ExecutionID to abort.
max_retriesThe amount of times to retry, if aborting fails.

Definition at line 335 of file SkillManagerWrapper.cpp.

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

◆ updateAvailable

void updateAvailable ( Snapshot update)
signal
+ Here is the caller graph for this function:

◆ updateFromMemory

void updateFromMemory ( )
slot

Requests this wrapper to overwrite its own state from memory.

Definition at line 235 of file SkillManagerWrapper.cpp.

+ Here is the call graph for this function:
The documentation for this class was generated from the following files: