onboardapi  9.10.0
by Rheinmetall
M_Alignment::IClient Class Reference

Public Member Functions

virtual ~IClient ()
 
virtual void ReportAlignmentSettings (M_Alignment::AlignmentSettingsType const &Settings)
 
virtual void ReportAlignmentStatus (std::string const &KeyComponentId, M_Alignment::AlignmentStatusType const &Status, bool IsRemoved)
 

Detailed Description

Alignment client interface. Contains callback operations from the alignment service to the client.

Constructor & Destructor Documentation

◆ ~IClient()

M_Alignment::IClient::~IClient ( )
virtual

Member Function Documentation

◆ ReportAlignmentSettings()

void M_Alignment::IClient::ReportAlignmentSettings ( M_Alignment::AlignmentSettingsType const &  Settings)
virtual

Report alignment static settings.

Parameters
SettingsAlignment settings.

◆ ReportAlignmentStatus()

void M_Alignment::IClient::ReportAlignmentStatus ( std::string const &  KeyComponentId,
M_Alignment::AlignmentStatusType const &  Status,
bool  IsRemoved 
)
virtual

Report current alignment status.

Parameters
KeyComponentIdIdentifies the device/component associated with the alignment status
StatusAlignment status data.
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.