onboardapi  9.10.0
by Rheinmetall
M_TerminalCtrl::IService Class Reference

Public Member Functions

virtual ~IService ()
 
virtual void ConfigTerminalState (M_TerminalCtrl::TerminalRequiredStateType const &State, bool IsRemoved)
 
virtual void ConfigMenuLanguage (std::string const &MenuLanguage)
 
virtual void CmdExitMenu ()
 Cmd to force the Terminal to exit the current menu. More...
 
virtual void CmdIsTerminalAlive ()
 
virtual void CmdSetBlackoutMode (bool Enable)
 

Detailed Description

Terminal Control Service interface. Contains operations that a client can command the Terminal Control Service to perform.

Constructor & Destructor Documentation

◆ ~IService()

M_TerminalCtrl::IService::~IService ( )
virtual

Member Function Documentation

◆ CmdExitMenu()

void M_TerminalCtrl::IService::CmdExitMenu ( )
virtual

Cmd to force the Terminal to exit the current menu.

◆ CmdIsTerminalAlive()

void M_TerminalCtrl::IService::CmdIsTerminalAlive ( )
virtual

Cmd to check if Terminal Control Service is alive. If the Service is not available then an exception will thrown.

◆ CmdSetBlackoutMode()

void M_TerminalCtrl::IService::CmdSetBlackoutMode ( bool  Enable)
virtual

Cmd to set terminal in blackout mode. Blackout mode turns off all lighting for the complete terminal.

Parameters
EnableIndicates if blackout mode should be enabled (true) or disabled (false).

◆ ConfigMenuLanguage()

void M_TerminalCtrl::IService::ConfigMenuLanguage ( std::string const &  MenuLanguage)
virtual

Configures menu language.

Parameters
MenuLanguageMenu language to select.

◆ ConfigTerminalState()

void M_TerminalCtrl::IService::ConfigTerminalState ( M_TerminalCtrl::TerminalRequiredStateType const &  State,
bool  IsRemoved 
)
virtual

Configures the state data that a Terminal should use.

Parameters
StateCurrent state data to be used by the Terminal.
IsRemovedIndicates if the Terminal is no longer being commanded by the Terminal Manager.