M_OverlayCtrl::IService Class Reference

Public Member Functions
virtual	~IService ()
virtual void	ConfigEnableOverlay (std::string const &KeyOverlayName, bool Enable, bool IsRemoved)
virtual void	ConfigColourStyle (std::string const &KeyOverlayName, M_Common::ColourStyleType const &ColourStyle, bool IsRemoved)

Detailed Description

Overlay Control Service interface. Contains operations that a Client can command the Overlay Control Service to perform.

Constructor & Destructor Documentation

~IService()

M_OverlayCtrl::IService::~IService ( )

virtual

Member Function Documentation

ConfigColourStyle()

void M_OverlayCtrl::IService::ConfigColourStyle ( std::string const &  KeyOverlayName, M_Common::ColourStyleType const &  ColourStyle, bool  IsRemoved  )

virtual

Configure overlay colour style.

Parameters

KeyOverlayName	Identifies the overlay.
ColourStyle	Overlay colour style.
IsRemoved	Indicates 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.

ConfigEnableOverlay()

void M_OverlayCtrl::IService::ConfigEnableOverlay ( std::string const &  KeyOverlayName, bool  Enable, bool  IsRemoved  )

virtual

Configure to enable (true) or disable (false) a specified Overlay.

Parameters

KeyOverlayName	The name of the Overlay to enable or disable. Note: The supported names are reported by the Service in the settings on startup.
Enable	Indicates if the specified Overlay should be enabled (true) or disabled (false).
IsRemoved	Indicates 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.