onboardapi  9.10.0
by Rheinmetall
M_SectorSelection::IClient Class Reference

Public Member Functions

virtual ~IClient ()
 
virtual void ReportSectorSelectionSettings (M_SectorSelection::SectorSelectionSettingsType const &Settings)
 
virtual void ReportSectorDefinitions (M_SectorSelection::SectorDefinitionListType const &AvailableSectors)
 
virtual void ReportSectorSelectionStatus (M_SectorSelection::SectorSelectionStatusType const &Status, bool IsRemoved)
 

Detailed Description

Sector Selection Client interface. Contains callback operations from the Sector Selection Service to the Client.

Constructor & Destructor Documentation

◆ ~IClient()

M_SectorSelection::IClient::~IClient ( )
virtual

Member Function Documentation

◆ ReportSectorDefinitions()

void M_SectorSelection::IClient::ReportSectorDefinitions ( M_SectorSelection::SectorDefinitionListType const &  AvailableSectors)
virtual

Reports the definition (size and position) of all available sectors.

Parameters
AvailableSectorsDefines the sectors currently available in the Selection Service.

◆ ReportSectorSelectionSettings()

void M_SectorSelection::IClient::ReportSectorSelectionSettings ( M_SectorSelection::SectorSelectionSettingsType const &  Settings)
virtual

Reports static settings for Sector Selection Service.

Parameters
SettingsSector Selection Service settings data.

◆ ReportSectorSelectionStatus()

void M_SectorSelection::IClient::ReportSectorSelectionStatus ( M_SectorSelection::SectorSelectionStatusType const &  Status,
bool  IsRemoved 
)
virtual

Reports the selection status of all sectors. This is used to inform Clients which sectors are selected and which are not selected.

Parameters
StatusSector Selection 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.