Public Member Functions
virtual	~IService ()

virtual void	ConfigAxisLabel (uint32_t KeyAxisIndex, std::string const &NegativeLabel, M_Common::ImageType const &NegativeImage, std::string const &PositiveLabel, M_Common::ImageType const &PositiveImage, bool IsRemoved)

virtual void	ConfigStatusLed (uint32_t KeyLedIndex, M_HidDisplay::LedLightModeType const &LedLightMode, bool IsRemoved)

virtual void	ConfigBackgroundIllumination (M_Common::PercentType Level)

virtual void	ConfigBlackoutMode (bool Enable)

virtual void	ConfigButtonLabel (uint32_t KeyButtonIndex, std::string const &Label, M_Common::ImageType const &Image, bool IsEnabled, bool IsHighlighted, bool IsRemoved)

virtual void	ConfigValueInput (uint32_t KeyValueInputIndex, std::string const &Label, bool IsEnabled, M_Common::PropertyOptionalType const &ValueInputMode, M_Common::PropertyOptionalType const &DefaultValue, M_Common::PropertyOptionalType const &MinValue, M_Common::PropertyOptionalType const &MaxValue, M_Common::PropertyListType const &PresetList, bool IsRemoved)

virtual void	ConfigMenuLabel (uint32_t KeyMenuIndex, std::string const &Label, bool IsEnabled, bool IsRemoved)

virtual void	CmdSelectButton (uint32_t ButtonIndex, bool IsSelected)

Detailed Description

Service interface. Contains operations that a client can command the Service to perform.

Constructor & Destructor Documentation

◆ ~IService()

M_HidDisplay::IService::~IService ( )

virtual

Member Function Documentation

◆ CmdSelectButton()

void M_HidDisplay::IService::CmdSelectButton	(	uint32_t	ButtonIndex,
		bool	IsSelected
	)

virtual

Cmd to trigger a button press (IsSelected = True) or release (IsSelected = False). Note: This function can be used to trigger a HID button from a HW button input.

Parameters

ButtonIndex	Index identifying the button.
IsSelected	Indicates if the button has been selected (true) or unselected (false).

◆ ConfigAxisLabel()

void M_HidDisplay::IService::ConfigAxisLabel	(	uint32_t	KeyAxisIndex,
		std::string const &	NegativeLabel,
		M_Common::ImageType const &	NegativeImage,
		std::string const &	PositiveLabel,
		M_Common::ImageType const &	PositiveImage,
		bool	IsRemoved
	)

virtual

Config to set the label and image to be displayed for an axis. Note: This function is only relevant for input devices which can display this kind of information.

Parameters

KeyAxisIndex	Index identifying the axis.
NegativeLabel	Label to display for the negative axis.
NegativeImage	Image to display for the negative axis.
PositiveLabel	Label to display for the positive axis.
PositiveImage	Image to display for the positive axis.
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.

◆ ConfigBackgroundIllumination()

void M_HidDisplay::IService::ConfigBackgroundIllumination ( M_Common::PercentType Level )

virtual

Config for the background illumination level.

Parameters

Level The illumination level in percent.

◆ ConfigBlackoutMode()

void M_HidDisplay::IService::ConfigBlackoutMode ( bool Enable )

virtual

Config to indicate if display should be in blackout mode. Blackout mode turns off all lighting for the complete HID display device.

Parameters

Enable Indicates if blackout mode should be enabled (true) or disabled (false).

◆ ConfigButtonLabel()

void M_HidDisplay::IService::ConfigButtonLabel	(	uint32_t	KeyButtonIndex,
		std::string const &	Label,
		M_Common::ImageType const &	Image,
		bool	IsEnabled,
		bool	IsHighlighted,
		bool	IsRemoved
	)

virtual

Config with the label and image to be displayed for a button. Note: This function is only relevant for input devices which can display this kind of information.

Parameters

KeyButtonIndex	Index identifying the button.
Label	Label to display for the button.
Image	Image to display for the button.
IsEnabled	Indicates if the button is enabled (true) or disabled (false). An enabled button can be used by the user. A disabled button can NOT be used by the user. True = Enabled False = Disabled
IsHighlighted	Indicates if the button is highlighted (true). True = Highlighted False = Not highlighted
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.

◆ ConfigMenuLabel()

void M_HidDisplay::IService::ConfigMenuLabel	(	uint32_t	KeyMenuIndex,
		std::string const &	Label,
		bool	IsEnabled,
		bool	IsRemoved
	)

virtual

Configure the specified menu label.

Parameters

KeyMenuIndex	Index identifying the menu.
Label	Label to display.
IsEnabled	Indicates whether the element is enabled.
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.

◆ ConfigStatusLed()

void M_HidDisplay::IService::ConfigStatusLed	(	uint32_t	KeyLedIndex,
		M_HidDisplay::LedLightModeType const &	LedLightMode,
		bool	IsRemoved
	)

virtual

Config to indicate if an LED should be on or off.

Parameters

KeyLedIndex	Index identifying the LED.
LedLightMode	Indicates the LED light mode. Can be On/Off or a specific pattern.
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.

◆ ConfigValueInput()

void M_HidDisplay::IService::ConfigValueInput	(	uint32_t	KeyValueInputIndex,
		std::string const &	Label,
		bool	IsEnabled,
		M_Common::PropertyOptionalType const &	ValueInputMode,
		M_Common::PropertyOptionalType const &	DefaultValue,
		M_Common::PropertyOptionalType const &	MinValue,
		M_Common::PropertyOptionalType const &	MaxValue,
		M_Common::PropertyListType const &	PresetList,
		bool	IsRemoved
	)

virtual

Configure the specified value input.

Parameters

KeyValueInputIndex	Index identifying the value input.
Label	Label of the value input.
IsEnabled	Indicates whether value input info is enabled.
ValueInputMode	Value input mode.
DefaultValue	Default value.
MinValue	Minimum value.
MaxValue	Maximum value.
PresetList	Preset list.
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.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IService()

Member Function Documentation

◆ CmdSelectButton()

◆ ConfigAxisLabel()

◆ ConfigBackgroundIllumination()

◆ ConfigBlackoutMode()

◆ ConfigButtonLabel()

◆ ConfigMenuLabel()

◆ ConfigStatusLed()

◆ ConfigValueInput()