M_OverlayCtrl::ReportOverlayStatus Struct Reference

Public Member Functions
	ReportOverlayStatus ()
	ReportOverlayStatus (std::string const &KeyOverlayName, M_OverlayCtrl::OverlayCtrlStatusType const &Status, bool IsRemoved)

Public Attributes
std::string	KeyOverlayName
	The name of the overlay. More...
M_OverlayCtrl::OverlayCtrlStatusType	Status
	Overlay control status. More...
bool	IsRemoved

Detailed Description

Report with the current status for an Overlay. This will be reported for every Overlay and updated every time a status is changed.

Constructor & Destructor Documentation

ReportOverlayStatus() [1/2]

M_OverlayCtrl::ReportOverlayStatus::ReportOverlayStatus

(

)

ReportOverlayStatus() [2/2]

M_OverlayCtrl::ReportOverlayStatus::ReportOverlayStatus	(	std::string const &	KeyOverlayName,
		M_OverlayCtrl::OverlayCtrlStatusType const &	Status,
		bool	IsRemoved
	)

Member Data Documentation

IsRemoved

bool M_OverlayCtrl::ReportOverlayStatus::IsRemoved

Indicates if the status is no longer available. Note: This will always be set to true when a service has been shut down. After this has been set to true, the status will no longer be available to late joiners.

KeyOverlayName

std::string M_OverlayCtrl::ReportOverlayStatus::KeyOverlayName

The name of the overlay.

Status

M_OverlayCtrl::OverlayCtrlStatusType M_OverlayCtrl::ReportOverlayStatus::Status

Overlay control status.