onboardapi  9.10.0
by Rheinmetall
M_Teleoperation::IClient Class Reference

Public Member Functions

virtual ~IClient ()
 
virtual void ReportTeleoperationCtrlSettings (M_Teleoperation::TeleoperationCtrlSettingsType const &TeleoperationCtrlSettings)
 
virtual void ReportBatteryStatus (std::string const &KeyId, M_Teleoperation::BatteryStatusType const &BatteryStatus, bool IsRemoved)
 
virtual void ReportRadioConnectionStatus (std::string const &KeyId, M_Teleoperation::RadioConnectionStatusType const &RadioConnectionStatus, bool IsRemoved)
 

Detailed Description

Teleoperation client interface. Contains callback operations from the teleoperation service to the client.

Constructor & Destructor Documentation

◆ ~IClient()

M_Teleoperation::IClient::~IClient ( )
virtual

Member Function Documentation

◆ ReportBatteryStatus()

void M_Teleoperation::IClient::ReportBatteryStatus ( std::string const &  KeyId,
M_Teleoperation::BatteryStatusType const &  BatteryStatus,
bool  IsRemoved 
)
virtual

Report current battery status.

Parameters
KeyIdIdentifies the battery.
BatteryStatusCurrent status of the battery.
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.

◆ ReportRadioConnectionStatus()

void M_Teleoperation::IClient::ReportRadioConnectionStatus ( std::string const &  KeyId,
M_Teleoperation::RadioConnectionStatusType const &  RadioConnectionStatus,
bool  IsRemoved 
)
virtual

Report current radio connection status.

Parameters
KeyIdIdentifies the radio connection.
RadioConnectionStatusCurrent status of the radio connection.
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.

◆ ReportTeleoperationCtrlSettings()

void M_Teleoperation::IClient::ReportTeleoperationCtrlSettings ( M_Teleoperation::TeleoperationCtrlSettingsType const &  TeleoperationCtrlSettings)
virtual

Report static settings. This should be provided at startup and in the event of degraded functionality, e.g. due to an internal failure.

Parameters
TeleoperationCtrlSettingsSettings of the remote system.