onboardapi  9.10.0
by Rheinmetall
M_MissionCtrl::IClient Class Reference

Public Member Functions

virtual ~IClient ()
 
virtual void ReportMissionCtrlSettings (M_MissionCtrl::MissionCtrlSettingsType const &MissionCtrlSettings)
 
virtual void ReportMissionStatus (M_MissionCtrl::MissionStatusType const &MissionStatus, bool IsRemoved)
 
virtual void ReportStoredMission (std::string const &KeyName, M_MissionCtrl::MissionType const &Mission, bool IsRemoved)
 
virtual void ReportMap (M_MissionCtrl::MultiLevelSurfaceMapType const &MlsMap)
 

Detailed Description

Mission control client interface. Contains callback operations from the mission control service to a client.

Constructor & Destructor Documentation

◆ ~IClient()

M_MissionCtrl::IClient::~IClient ( )
virtual

Member Function Documentation

◆ ReportMap()

void M_MissionCtrl::IClient::ReportMap ( M_MissionCtrl::MultiLevelSurfaceMapType const &  MlsMap)
virtual

Report a map (partition).

Parameters
MlsMapMulti-level surface map.

◆ ReportMissionCtrlSettings()

void M_MissionCtrl::IClient::ReportMissionCtrlSettings ( M_MissionCtrl::MissionCtrlSettingsType const &  MissionCtrlSettings)
virtual

Report the static settings of the mission control service.

Parameters
MissionCtrlSettingsSettings of the mission control service.

◆ ReportMissionStatus()

void M_MissionCtrl::IClient::ReportMissionStatus ( M_MissionCtrl::MissionStatusType const &  MissionStatus,
bool  IsRemoved 
)
virtual

Report the current status of the specified mission.

Parameters
MissionStatusCurrent status of the specified mission.
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.

◆ ReportStoredMission()

void M_MissionCtrl::IClient::ReportStoredMission ( std::string const &  KeyName,
M_MissionCtrl::MissionType const &  Mission,
bool  IsRemoved 
)
virtual

Report the current status of the specified mission.

Parameters
KeyNameIdentifies the mission or action.
MissionCurrent status of the specified mission.
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.