SimRacing::Shifter Class Reference

Base class for all shifter instances. More...

#include <SimRacing.h>

Inheritance diagram for SimRacing::Shifter:

Public Types
using	Gear = int8_t
	Type alias for gear numbers.

Public Member Functions
	Shifter (Gear min, Gear max)
	Class constructor.
Gear	getGear () const
	Returns the currently selected gear.
char	getGearChar () const
	Returns a character that represents the current gear.
String	getGearString () const
	Returns a String that represents the current gear.
bool	gearChanged () const
	Checks whether the current gear has changed since the last update.
Gear	getGearMin ()
	Retrieves the minimum possible gear index.
Gear	getGearMax ()
	Retrieves the maximum possible gear index.
virtual void	begin ()
	Initialize the hardware (if necessary)
bool	update ()
	Perform a poll of the hardware to refresh the class state.
bool	isConnected () const
	Check if the device is physically connected to the board.
void	setStablePeriod (unsigned long t)
	Set how long the detection pin must be stable for before the device is considered to be 'connected'.

Static Public Member Functions
static char	getGearChar (int gear)
	Returns a character that represents the given gear.
static String	getGearString (int gear)
	Returns a String that represents the given gear.

Protected Member Functions
void	setGear (Gear gear)
	Changes the currently set gear, internally.
virtual bool	updateState (bool connected)=0
	Perform an internal poll of the hardware to refresh the class state.
void	setDetectPtr (DeviceConnection *d)
	Sets the pointer to the detector object.

Detailed Description

Base class for all shifter instances.

Definition at line 505 of file SimRacing.h.

Member Typedef Documentation

Gear

using SimRacing::Shifter::Gear = int8_t

Type alias for gear numbers.

Definition at line 510 of file SimRacing.h.

Constructor & Destructor Documentation

Shifter()

SimRacing::Shifter::Shifter	(	Gear	min,
		Gear	max )

Class constructor.

Parameters

min	the lowest gear possible
max	the highest gear possible

Definition at line 728 of file SimRacing.cpp.

Member Function Documentation

begin()

virtual void SimRacing::Peripheral::begin ( )

inlinevirtualinherited

Initialize the hardware (if necessary)

Reimplemented in SimRacing::AnalogShifter, SimRacing::Handbrake, SimRacing::LogitechShifterG25, SimRacing::LogitechShifterG27, and SimRacing::Pedals.

Definition at line 261 of file SimRacing.h.

gearChanged()

bool SimRacing::Shifter::gearChanged ( ) const

inline

Checks whether the current gear has changed since the last update.

Returns

'true' if gear has changed, 'false' otherwise

Examples

LogitechShifter_Joystick.ino, and LogitechShifter_Print.ino.

Definition at line 572 of file SimRacing.h.

getGear()

Gear SimRacing::Shifter::getGear ( ) const

inline

Returns the currently selected gear.

Will either be reverse (-1), neutral (0), or the current gear indexed at 1 (1st gear is 1, 2nd gear is 2, etc.).

Returns

current gear index

Examples

LogitechShifterG25_Joystick.ino, LogitechShifterG27_Joystick.ino, LogitechShifter_Joystick.ino, and LogitechShifter_Print.ino.

Definition at line 528 of file SimRacing.h.

getGearChar() [1/2]

char SimRacing::Shifter::getGearChar

(

)

const

Returns a character that represents the current gear.

Returns

letter representing the current gear

See also

getGearChar(int)

Definition at line 763 of file SimRacing.cpp.

getGearChar() [2/2]

char SimRacing::Shifter::getGearChar ( int gear )

static

Returns a character that represents the given gear.

'r' for reverse, 'n' for neutral, or the number of the current gear.

Parameters

gear	the gear index to get the representation for

Returns

letter representing the current gear

Examples

LogitechShifterG25_Print.ino, and LogitechShifterG27_Print.ino.

Definition at line 745 of file SimRacing.cpp.

getGearMax()

Gear SimRacing::Shifter::getGearMax ( )

inline

Retrieves the maximum possible gear index.

Returns

the highest gear index

Definition at line 588 of file SimRacing.h.

getGearMin()

Gear SimRacing::Shifter::getGearMin ( )

inline

Retrieves the minimum possible gear index.

Returns

the lowest gear index

Definition at line 581 of file SimRacing.h.

getGearString() [1/2]

String SimRacing::Shifter::getGearString

(

)

const

Returns a String that represents the current gear.

Returns

String representing the current gear

See also

getGearString(int)

Definition at line 804 of file SimRacing.cpp.

getGearString() [2/2]

String SimRacing::Shifter::getGearString ( int gear )

static

Returns a String that represents the given gear.

"reverse" for reverse, "neutral" for neutral, and then "1st", "2nd", "3rd", and so on.

Parameters

gear	the gear index to get the representation for

Returns

String representing the current gear

Examples

LogitechShifter_Print.ino.

Definition at line 767 of file SimRacing.cpp.

isConnected()

bool SimRacing::Peripheral::isConnected ( ) const

inherited

Check if the device is physically connected to the board.

That means it is both present and detected long enough to be considered 'stable'.

Returns

'true' if the device is connected, 'false' otherwise

Definition at line 446 of file SimRacing.cpp.

setDetectPtr()

void SimRacing::Peripheral::setDetectPtr ( DeviceConnection * d )

protectedinherited

Sets the pointer to the detector object.

The detector object is used to check if the peripheral is connected to the microcontroller. The object is polled on every update.

Although the detector instance is accessed via the Peripheral class, it is the responsibility of the dervied class to store the DeviceConnection object and manage its lifetime.

Parameters

d	pointer to the detector object

Definition at line 456 of file SimRacing.cpp.

setGear()

void SimRacing::Shifter::setGear ( Gear gear )

protected

Changes the currently set gear, internally.

This function sanitizes the newly selected gear with MinGear / MaxGear, and handles caching the previous value for checking if the gear has changed.

Parameters

gear	the new gear value to set

Definition at line 735 of file SimRacing.cpp.

setStablePeriod()

void SimRacing::Peripheral::setStablePeriod ( unsigned long t )

inherited

Set how long the detection pin must be stable for before the device is considered to be 'connected'.

Parameters

t	the amount of time, in ms, the input must be stable for (no changes) before it's interpreted as 'detected'

Definition at line 460 of file SimRacing.cpp.

update()

bool SimRacing::Peripheral::update ( )

inherited

Perform a poll of the hardware to refresh the class state.

Returns

'true' if device state changed, 'false' otherwise

Examples

HandbrakeJoystick.ino, HandbrakePrint.ino, LogitechShifterG25_Joystick.ino, LogitechShifterG25_Print.ino, LogitechShifterG27_Joystick.ino, LogitechShifterG27_Print.ino, LogitechShifter_Joystick.ino, LogitechShifter_Print.ino, PedalsJoystick.ino, and PedalsPrint.ino.

Definition at line 433 of file SimRacing.cpp.

updateState()

virtual bool SimRacing::Peripheral::updateState ( bool connected )

protectedpure virtualinherited

Perform an internal poll of the hardware to refresh the class state.

This function is called from within the public update() in order to refresh the cached state of the peripheral. It needs to be defined in every derived class. This function is the only place where the cached device state should be changed.

Parameters

connected

the state of the device connection

Returns

'true' if device state changed, 'false' otherwise

Implemented in SimRacing::AnalogShifter, SimRacing::Handbrake, SimRacing::LogitechShifterG25, SimRacing::LogitechShifterG27, and SimRacing::Pedals.

---

The documentation for this class was generated from the following files:

• SimRacing.h
• SimRacing.cpp