onboardapi  9.10.0
by Rheinmetall
M_HidManager::IService Class Reference

Public Member Functions

virtual ~IService ()
 
virtual void CmdIsHidManagerAlive ()
 
virtual void ConfigHidAssignment (std::string const &KeyAppName, M_HidManager::RequestedAxisListType const &RequestedAxes, M_HidManager::RequestedValueInputListType const &RequestedValueInputs, M_HidManager::RequestedButtonListType const &RequestedButtons, M_HidManager::RequestedMenuListType const &RequestedMenus, bool IsRemoved)
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ~IService()

M_HidManager::IService::~IService ( )
virtual

Member Function Documentation

◆ CmdIsHidManagerAlive()

void M_HidManager::IService::CmdIsHidManagerAlive ( )
virtual

Command to check if service is alive. If the service is not available, then an exception will be thrown.

◆ ConfigHidAssignment()

void M_HidManager::IService::ConfigHidAssignment ( std::string const &  KeyAppName,
M_HidManager::RequestedAxisListType const &  RequestedAxes,
M_HidManager::RequestedValueInputListType const &  RequestedValueInputs,
M_HidManager::RequestedButtonListType const &  RequestedButtons,
M_HidManager::RequestedMenuListType const &  RequestedMenus,
bool  IsRemoved 
)
virtual

Used to assign various elements of the HID Manager. Note: The HID Manager should respond to the assignment with the EventHidAssignment() operation.

Parameters
KeyAppNameName of the application issuing the request.
RequestedAxesList of axes needed by the client.
RequestedValueInputsList of value inputs needed by the client.
RequestedButtonsList of buttons needed by the client.
RequestedMenusList of menus needed by the client.
IsRemovedIndicates 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.