onboardapi  9.10.0
by Rheinmetall
M_OverlayCtrl::ConfigEnableOverlay Struct Reference

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

Public Member Functions

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

Public Attributes

std::string KeyOverlayName
 
bool Enable
 Indicates if the specified Overlay should be enabled (true) or disabled (false). More...
 
bool IsRemoved
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ConfigEnableOverlay() [1/2]

M_OverlayCtrl::ConfigEnableOverlay::ConfigEnableOverlay ( )

◆ ConfigEnableOverlay() [2/2]

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

Member Data Documentation

◆ Enable

bool M_OverlayCtrl::ConfigEnableOverlay::Enable

Indicates if the specified Overlay should be enabled (true) or disabled (false).

◆ IsRemoved

bool M_OverlayCtrl::ConfigEnableOverlay::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.

◆ KeyOverlayName

std::string M_OverlayCtrl::ConfigEnableOverlay::KeyOverlayName

The name of the Overlay to enable or disable. Note: The supported names are reported by the Service in the settings on startup.