Abstract base class for all input devices that can be connected to a ControlPort. More...

#include <ControlDevice.h>

Inheritance diagram for Ship::ControlDevice:

Public Member Functions
	ControlDevice (uint8_t portIndex)
	Constructs a ControlDevice bound to the given port.

virtual	~ControlDevice ()

Protected Attributes
uint8_t	mPortIndex
	Zero-based port index this device is connected to.

Detailed Description

Abstract base class for all input devices that can be connected to a ControlPort.

ControlDevice is the root of the controller device hierarchy. Every concrete device (currently only Controller) stores the port index it is connected to, which is used throughout the mapping and config systems to namespace persisted settings.

See also: Controller, ControlPort

Constructor & Destructor Documentation

◆ ControlDevice()

Ship::ControlDevice::ControlDevice ( uint8_t portIndex )

Constructs a ControlDevice bound to the given port.

Parameters

portIndex Zero-based controller port index (0 = port 1).

◆ ~ControlDevice()

virtual Ship::ControlDevice::~ControlDevice ( )

virtual

Member Data Documentation

◆ mPortIndex

uint8_t Ship::ControlDevice::mPortIndex

protected

Zero-based port index this device is connected to.

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

include/ship/controller/controldevice/ControlDevice.h