M_HmiAppCtrl::IService Class Reference

Public Member Functions
virtual	~IService ()
virtual void	ConfigView (std::string const &KeyViewId, M_HmiAppCtrl::ViewDescriptionType const &ViewDesc, bool IsRemoved)
virtual void	CmdActivateView (std::string const &ViewId)
virtual void	CmdRegisterApp (std::string const &AppId, M_HmiAppCtrl::ApplicationDescriptionType const &AppDesc)
virtual void	CmdInstallApp (std::string const &AppId, M_HmiAppCtrl::ApplicationDescriptionType const &AppDesc)
virtual void	CmdRunApp (std::string const &AppId)
virtual void	CmdSwitchToApp (std::string const &AppId)
virtual void	CmdTerminateApp (std::string const &AppId)
virtual void	CmdRestartApp (std::string const &AppId)
virtual void	CmdUninstallApp (std::string const &AppId)
virtual void	CmdUnregisterApp (std::string const &AppId)
virtual void	CmdActivateContext (std::string const &ContextName, bool IsActive)

Detailed Description

Service interface. Contains operations that a client can command the HMI application control service to perform.

Constructor & Destructor Documentation

~IService()

M_HmiAppCtrl::IService::~IService ( )

virtual

Member Function Documentation

CmdActivateContext()

void M_HmiAppCtrl::IService::CmdActivateContext ( std::string const &  ContextName, bool  IsActive  )

virtual

Cmd to activate (true) or deactivate (false) a Context.

Parameters

ContextName	Context name.
IsActive	Indicates if the Context should be activated (true) or deactivated (false).

CmdActivateView()

void M_HmiAppCtrl::IService::CmdActivateView ( std::string const &  ViewId )

virtual

Cmd to activate an existing view.

Parameters

ViewId

Identifies the view which should be activated.

CmdInstallApp()

void M_HmiAppCtrl::IService::CmdInstallApp ( std::string const &  AppId, M_HmiAppCtrl::ApplicationDescriptionType const &  AppDesc  )

virtual

Install a new app during runtime. This informs the Service about a new app which should be handled and also saves the new app persistently in the configuration of the Service so that it is available after a restart. Note: This only installs the app, it does NOT start it.

Parameters

AppId	Identifies the app.
AppDesc	Configuration settings for an app.

CmdRegisterApp()

void M_HmiAppCtrl::IService::CmdRegisterApp ( std::string const &  AppId, M_HmiAppCtrl::ApplicationDescriptionType const &  AppDesc  )

virtual

Register a new app during runtime. This informs the Service about a new app which should be handled. Note: The registered app will NOT be saved in the configuration of the Service. This only registers the app, it does NOT start it.

Parameters

AppId	Identifies the app.
AppDesc	Configuration settings for an app.

CmdRestartApp()

void M_HmiAppCtrl::IService::CmdRestartApp ( std::string const &  AppId )

virtual

Restarts the app with the specified ID.

Parameters

AppId

Identifies the running app which should be restarted.

CmdRunApp()

void M_HmiAppCtrl::IService::CmdRunApp ( std::string const &  AppId )

virtual

Start the app with the specified ID.

Parameters

AppId

Identifies the managed app which should be started.

CmdSwitchToApp()

void M_HmiAppCtrl::IService::CmdSwitchToApp ( std::string const &  AppId )

virtual

Switch to the application with the specified ID.

Parameters

AppId

Identifies the managed application which should be switched to.

CmdTerminateApp()

void M_HmiAppCtrl::IService::CmdTerminateApp ( std::string const &  AppId )

virtual

Terminate the app with the specified ID.

Parameters

AppId

Identifies the running app which should be terminated.

CmdUninstallApp()

void M_HmiAppCtrl::IService::CmdUninstallApp ( std::string const &  AppId )

virtual

Unintall the managed app with the specified ID. This removed the app from the configuration in the Service so that it is no longer available after a restart. Note: This only removes the app from the configuration, it does NOT terminate the app if it is running.

Parameters

AppId

Identifies the managed app which should be uninstalled.

CmdUnregisterApp()

void M_HmiAppCtrl::IService::CmdUnregisterApp ( std::string const &  AppId )

virtual

Unregister the managed app with the specified ID. This removed the app from the current runtime configuration in the Service. The app may be termiated.

Parameters

AppId

Identifies the managed app which should be unregistered.

ConfigView()

void M_HmiAppCtrl::IService::ConfigView ( std::string const &  KeyViewId, M_HmiAppCtrl::ViewDescriptionType const &  ViewDesc, bool  IsRemoved  )

virtual

Configure rules for UI display elements.

Parameters

KeyViewId	Identifies the view.
ViewDesc	Configuration settings for a view.
IsRemoved	Indicates if the view should be removed by the service (true) or not (false). Note: After this has been set to true, the view will no longer be available to late joiners.