onboardapi  9.10.0
by Rheinmetall
M_HmiAppCtrl::IClient Class Reference

Public Member Functions

virtual ~IClient ()
 
virtual void ReportView (std::string const &KeyViewId, M_HmiAppCtrl::ViewDescriptionType const &ViewDesc, bool IsRemoved)
 
virtual void ReportManagedApps (M_HmiAppCtrl::ApplicationDescriptionListType const &AppList)
 
virtual void ReportAppState (std::string const &KeyAppId, M_HmiAppCtrl::ApplicationStateType const &AppState, bool IsRemoved)
 
virtual void ReportActiveContexts (M_Common::StringListType const &ContextNameList)
 

Detailed Description

Client interface. Contains operations reported by a HMI application control service.

Constructor & Destructor Documentation

◆ ~IClient()

M_HmiAppCtrl::IClient::~IClient ( )
virtual

Member Function Documentation

◆ ReportActiveContexts()

void M_HmiAppCtrl::IClient::ReportActiveContexts ( M_Common::StringListType const &  ContextNameList)
virtual

Reports the current active Contexts.

Parameters
ContextNameListList of currently active Contexts.

◆ ReportAppState()

void M_HmiAppCtrl::IClient::ReportAppState ( std::string const &  KeyAppId,
M_HmiAppCtrl::ApplicationStateType const &  AppState,
bool  IsRemoved 
)
virtual

Reports the current state of an app.

Parameters
KeyAppIdIdentifies the app.
AppStateStatus information for the app.
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.

◆ ReportManagedApps()

void M_HmiAppCtrl::IClient::ReportManagedApps ( M_HmiAppCtrl::ApplicationDescriptionListType const &  AppList)
virtual

Reports the list of the managed apps.

Parameters
AppListList of managed apps.

◆ ReportView()

void M_HmiAppCtrl::IClient::ReportView ( std::string const &  KeyViewId,
M_HmiAppCtrl::ViewDescriptionType const &  ViewDesc,
bool  IsRemoved 
)
virtual

Reports a view.

Parameters
KeyViewIdIdentifies the view.
ViewDescConfiguration settings for the view.
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.