onboardapi  9.10.0
by Rheinmetall
M_ActuationCtrl::IClient Class Reference
Inheritance diagram for M_ActuationCtrl::IClient:
M_Manipulator::IClient

Public Member Functions

virtual ~IClient ()
 
virtual void ReportActuationCtrlSettings (M_ActuationCtrl::ActuationCtrlSettingsType const &Settings)
 
virtual void ReportActuationComponentStatus (std::string const &KeyId, M_ActuationCtrl::ActuationStatusType const &Status, bool IsRemoved)
 

Detailed Description

Actuator control client interface. Contains callback operations from the actuation control service to a client.

Constructor & Destructor Documentation

◆ ~IClient()

M_ActuationCtrl::IClient::~IClient ( )
virtual

Reimplemented in M_Manipulator::IClient.

Member Function Documentation

◆ ReportActuationComponentStatus()

void M_ActuationCtrl::IClient::ReportActuationComponentStatus ( std::string const &  KeyId,
M_ActuationCtrl::ActuationStatusType const &  Status,
bool  IsRemoved 
)
virtual

Report the current status of a specific actuation component.

Parameters
KeyIdIdentifies the actuation component.
StatusActuation component output.
IsRemovedIndicates if the status is no longer available. Note: This will always be set to true when a service has been shut down. After this has been set to true, the status will no longer be available to late joiners.

◆ ReportActuationCtrlSettings()

void M_ActuationCtrl::IClient::ReportActuationCtrlSettings ( M_ActuationCtrl::ActuationCtrlSettingsType const &  Settings)
virtual

Report the static settings of the actuation control service.

Parameters
SettingsSettings of the actuation control service.