onboardapi  9.10.0
by Rheinmetall
M_MissionCtrl::IService Class Reference

Public Member Functions

virtual ~IService ()
 
virtual void CmdPerformAction (M_MissionCtrl::CommandedActionType const &Action)
 
virtual void CmdPerformMission (std::string const &Name, M_MissionCtrl::MissionOptionalType const &Mission)
 
virtual void CmdAbortMission (std::string const &Name)
 
virtual void ConfigStoreMission (std::string const &KeyName, M_MissionCtrl::MissionType const &Mission, bool IsRemoved)
 
virtual void CmdDeleteMission (std::string const &Name)
 

Detailed Description

Mission control service interface. Contains operations that a client can command the mission control service to perform.

Constructor & Destructor Documentation

◆ ~IService()

M_MissionCtrl::IService::~IService ( )
virtual

Member Function Documentation

◆ CmdAbortMission()

void M_MissionCtrl::IService::CmdAbortMission ( std::string const &  Name)
virtual

Abort a specified mission.

Parameters
NameIdentifies the mission.

◆ CmdDeleteMission()

void M_MissionCtrl::IService::CmdDeleteMission ( std::string const &  Name)
virtual

Delete a specified mission.

Parameters
NameIdentifies the mission.

◆ CmdPerformAction()

void M_MissionCtrl::IService::CmdPerformAction ( M_MissionCtrl::CommandedActionType const &  Action)
virtual

Perform a specified action.

Parameters
ActionAction to perform.

◆ CmdPerformMission()

void M_MissionCtrl::IService::CmdPerformMission ( std::string const &  Name,
M_MissionCtrl::MissionOptionalType const &  Mission 
)
virtual

Perform a specified mission.

Parameters
NameIdentifies the mission.
MissionMission to perform.

◆ ConfigStoreMission()

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

Store a specified mission.

Parameters
KeyNameIdentifies the mission to be loaded. Note: Empty key should indicate to unload an existing mission.
MissionThe mission to be loaded.
IsRemovedIndicates if the payload is no longer available Note: This will always be set to true when the instance has been shut down After this has been set to true, the payload will no longer be available to late joiners.