onboardapi  9.10.0
by Rheinmetall
M_HidJoystick::IService Class Reference

Public Member Functions

virtual ~IService ()
 
virtual void CmdIsJoystickAlive ()
 
virtual void ConfigJoystickCurve (uint32_t KeyAxisIndex, std::string const &Curve, bool IsRemoved)
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ~IService()

M_HidJoystick::IService::~IService ( )
virtual

Member Function Documentation

◆ CmdIsJoystickAlive()

void M_HidJoystick::IService::CmdIsJoystickAlive ( )
virtual

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

◆ ConfigJoystickCurve()

void M_HidJoystick::IService::ConfigJoystickCurve ( uint32_t  KeyAxisIndex,
std::string const &  Curve,
bool  IsRemoved 
)
virtual

Parametrises joystick input scaling, i.e. how quickly a mount follows a joystick input (linearly, quadratically, ...).

Parameters
KeyAxisIndexIdentifies the axis.
CurveInput scaling characteristics.
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.