Open FFBoard
Open source force feedback firmware
Public Member Functions | Private Attributes | List of all members
ClassChooser< T > Class Template Reference

#include <ClassChooser.h>

Public Member Functions

 ClassChooser (const std::vector< class_entry< T > > &classes)
 
 ~ClassChooser ()
 
T * Create (uint16_t id)
 
bool isCreatable (uint16_t id)
 
void replyAvailableClasses (std::vector< CommandReply > &replies, int16_t ignoredCreatableId=255)
 
bool isValidClassId (uint16_t id)
 

Private Attributes

const std::vector< class_entry< T > > * class_registry
 

Detailed Description

template<class T>
class ClassChooser< T >

Definition at line 87 of file ClassChooser.h.

Constructor & Destructor Documentation

◆ ClassChooser()

template<class T >
ClassChooser< T >::ClassChooser ( const std::vector< class_entry< T > > &  classes)
inline

Definition at line 89 of file ClassChooser.h.

◆ ~ClassChooser()

template<class T >
ClassChooser< T >::~ClassChooser ( )
inline

Definition at line 92 of file ClassChooser.h.

Member Function Documentation

◆ Create()

template<class T >
T * ClassChooser< T >::Create ( uint16_t  id)
inline

Creates a new instance of class

Definition at line 100 of file ClassChooser.h.

◆ isCreatable()

template<class T >
bool ClassChooser< T >::isCreatable ( uint16_t  id)
inline

Check if class can be created Checks the isCreatable() function

Definition at line 116 of file ClassChooser.h.

◆ isValidClassId()

template<class T >
bool ClassChooser< T >::isValidClassId ( uint16_t  id)
inline

Returns if this id is actually in the list of possible classes

Definition at line 159 of file ClassChooser.h.

◆ replyAvailableClasses()

template<class T >
void ClassChooser< T >::replyAvailableClasses ( std::vector< CommandReply > &  replies,
int16_t  ignoredCreatableId = 255 
)
inline

Generates replies for the command system listing selectable classes

Definition at line 129 of file ClassChooser.h.

Member Data Documentation

◆ class_registry

template<class T >
const std::vector<class_entry<T> >* ClassChooser< T >::class_registry
private

Definition at line 168 of file ClassChooser.h.

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