class Joystick

Detailed Description

Wrapper class providing additional joystick information
This is a child class to expand another class with necessary joystick data.

For data not provided by class Peripheral.

Used on:

• kodi::addon::CInstancePeripheral::GetJoystickInfo()
• kodi::addon::CInstancePeripheral::GetFeatures().
• kodi::addon::CInstancePeripheral::MapFeatures().
• kodi::addon::CInstancePeripheral::GetIgnoredPrimitives().
• kodi::addon::CInstancePeripheral::SetIgnoredPrimitives().
• kodi::addon::CInstancePeripheral::SaveButtonMap().
• kodi::addon::CInstancePeripheral::RevertButtonMap().
• kodi::addon::CInstancePeripheral::ResetButtonMap().

---

The following table contains values that can be set with class Joystick :

Name	Type	Class	Set call	Get call
Joystick provider	const std::string&	Joystick	SetProvider	Provider
Joystick requested port	int	Joystick	SetRequestedPort	RequestedPort
Joystick button count	unsigned int	Joystick	SetButtonCount	ButtonCount
Joystick hat count	unsigned int	Joystick	SetHatCount	HatCount
Joystick axis count	unsigned int	Joystick	SetAxisCount	AxisCount
Joystick motor count	unsigned int	Joystick	SetMotorCount	MotorCount
Joystick support power off	bool	Joystick	SetSupportsPowerOff	SupportsPowerOff
Peripheral type	PERIPHERAL_TYPE	Peripheral	SetType	Type
Peripheral name	const std::string&	Peripheral	SetName	Name
Peripheral vendor id	uint16_t	Peripheral	SetVendorID	VendorID
Peripheral product id	uint16_t	Peripheral	SetProductID	ProductID
Peripheral index	unsigned int	Peripheral	SetIndex	Index

Further are following included:

• Joystick(const std::string& provider = "", const std::string& strName = "")
• Joystick& operator=(const Joystick& rhs)
• IsVidPidKnown(): To check VID and PID are known.

Modules
	Value Help

Function Documentation

Joystick() [1/2]

Joystick ( const std::string &  provider = "", const std::string &  strName = ""  )

inline

Constructor.

Parameters

[in]	provider	[optional] Provide name
[in]	strName	[optional] Name of related joystick

Joystick() [2/2]

Joystick ( const Joystick &  other )

inline

Class copy constructor.

Parameters

[in]

other

Other class to copy on construct here

~Joystick()

~Joystick ( void  )

overridedefault

Destructor.

operator=()

Joystick& operator= ( const Joystick &  rhs )

inline

Copy data from another Joystick class to here.

Parameters

[in]

other

Other class to copy here

Provider()

const std::string& Provider ( void  ) const

inline

Get provider name.

Returns

Name of provider

RequestedPort()

int RequestedPort ( void  ) const

inline

Get requested port number.

Returns

Port

ButtonCount()

unsigned int ButtonCount ( void  ) const

inline

Get button count.

Returns

Button count

HatCount()

unsigned int HatCount ( void  ) const

inline

Get hat count.

Returns

Hat count

AxisCount()

unsigned int AxisCount ( void  ) const

inline

Get axis count.

Returns

Axis count

MotorCount()

unsigned int MotorCount ( void  ) const

inline

Get motor count.

Returns

Motor count

SupportsPowerOff()

bool SupportsPowerOff ( void  ) const

inline

Get supports power off.

Returns

True if power off is supported, false otherwise

SetProvider()

void SetProvider ( const std::string &  provider )

inline

Set provider name.

Parameters

[in]

provider

Name of provider

SetRequestedPort()

void SetRequestedPort ( int  requestedPort )

inline

Get requested port number.

Parameters

[in]

requestedPort

Port

SetButtonCount()

void SetButtonCount ( unsigned int  buttonCount )

inline

Get button count.

Parameters

[in]

buttonCount

Button count

SetHatCount()

void SetHatCount ( unsigned int  hatCount )

inline

Get hat count.

Parameters

[in]

hatCount

Hat count

SetAxisCount()

void SetAxisCount ( unsigned int  axisCount )

inline

Get axis count.

Parameters

[in]

axisCount

Axis count

SetMotorCount()

void SetMotorCount ( unsigned int  motorCount )

inline

Get motor count.

Parameters

[in]

motorCount

Motor count

SetSupportsPowerOff()

void SetSupportsPowerOff ( bool  supportsPowerOff )

inline

Get supports power off.

Parameters

[in]

supportsPowerOff

True if power off is supported, false otherwise