Open FFBoard
Open source force feedback firmware
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | Friends | List of all members
ChoosableClass Class Referenceabstract

#include <ChoosableClass.h>

Inheritance diagram for ChoosableClass:
AnalogSource ButtonSource Encoder FFBoardMain MotorDriver ADS111X_AnalogSource CanAnalogBase LocalAnalog CanButtons LocalButtons PCF8574Buttons SPI_Buttons ShifterAnalog EncoderBissC EncoderLocal EncoderSSI MotorSimplemotion MtEncoderSPI ODriveCAN RmdMotorCAN TMC4671 VescCAN CanBridge CustomMain FFBHIDMain MidiMain TMCDebugBridge MotorPWM MotorSimplemotion ODriveCAN RmdMotorCAN TMC4671 VescCAN

Public Member Functions

virtual ~ChoosableClass ()
 
virtual const ClassIdentifier getInfo ()=0
 
uint16_t getSelectionID ()
 
virtual const ClassType getClassType ()
 returns the used classchooser selection id of this instance More...
 

Static Public Member Functions

static bool isCreatable ()
 

Static Public Attributes

static ClassIdentifier info
 

Protected Attributes

uint16_t selectionId
 Should only be written by ClassChooser during creation. More...
 

Friends

template<class T >
class ClassChooser
 

Detailed Description

Definition at line 24 of file ChoosableClass.h.

Constructor & Destructor Documentation

◆ ~ChoosableClass()

virtual ChoosableClass::~ChoosableClass ( )
inlinevirtual

Definition at line 30 of file ChoosableClass.h.

Member Function Documentation

◆ getClassType()

virtual const ClassType ChoosableClass::getClassType ( )
inlinevirtual

returns the used classchooser selection id of this instance

Type of this class. Mainclass, motordriver... Should be implemented by the parent class so it is not in the info struct

Reimplemented in ButtonSource, LocalButtons, AnalogSource, Encoder, MotorDriver, ADS111X_AnalogSource, FFBoardMain, LocalAnalog, PCF8574Buttons, ShifterAnalog, SPI_Buttons, and TMC4671.

Definition at line 49 of file ChoosableClass.h.

◆ getInfo()

virtual const ClassIdentifier ChoosableClass::getInfo ( )
pure virtual

Implemented in Encoder, MotorDriver, ADS111X_AnalogSource, CanAnalogBase, CanButtons, CustomMain, EncoderBissC, EncoderLocal, EncoderSSI, FFBHIDExt, FFBJoystick, FFBoardMain, FFBWheel, LocalAnalog, LocalButtons, MidiMain, MotorPWM, MotorSimplemotion1, MotorSimplemotion2, MtEncoderSPI, ODriveCAN1, ODriveCAN2, PCF8574Buttons, RmdMotorCAN1, RmdMotorCAN2, ShifterAnalog, TMC4671, TMCDebugBridge, VESC_1, VESC_2, CanBridge, SPI_Buttons_1, SPI_Buttons_2, AnalogSource, ButtonSource, FFBHIDMain, MotorSimplemotion, ODriveCAN, and RmdMotorCAN.

◆ getSelectionID()

uint16_t ChoosableClass::getSelectionID ( )
inline

Definition at line 43 of file ChoosableClass.h.

◆ isCreatable()

static bool ChoosableClass::isCreatable ( )
inlinestatic

Returns true if a new instance can be created. Use this to do prechecks if ressources are available If it returns false this can signal the classchooser that at this time a new instance can not be created.

Definition at line 40 of file ChoosableClass.h.

Friends And Related Function Documentation

◆ ClassChooser

template<class T >
friend class ClassChooser
friend

Definition at line 26 of file ChoosableClass.h.

Member Data Documentation

◆ info

ClassIdentifier ChoosableClass::info
static

Definition at line 32 of file ChoosableClass.h.

◆ selectionId

uint16_t ChoosableClass::selectionId
protected

Should only be written by ClassChooser during creation.

Definition at line 52 of file ChoosableClass.h.

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