Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
ola::rdm::SettingInterface Class Referenceabstract

Detailed Description

The base class all Settings inherit from.

Inheritance diagram for ola::rdm::SettingInterface:
Inheritance graph
[legend]

Public Member Functions

virtual std::string Description () const =0
 The text description of this setting. More...
 
virtual unsigned int DescriptionResponseSize () const =0
 Return the size of the _DESCRIPTION parameter data.
 
virtual unsigned int GenerateDescriptionResponse (uint8_t index, uint8_t *data) const =0
 Populate the _DESCRIPTION parameter data. More...
 

Member Function Documentation

virtual std::string ola::rdm::SettingInterface::Description ( ) const
pure virtual

The text description of this setting.

Returns
the string description of the setting.

Implemented in ola::rdm::FrequencyModulationSetting, and ola::rdm::BasicSetting.

virtual unsigned int ola::rdm::SettingInterface::GenerateDescriptionResponse ( uint8_t  index,
uint8_t *  data 
) const
pure virtual

Populate the _DESCRIPTION parameter data.

Parameters
indexthe index for this setting
datathe RDM parameter data to write to.

Implemented in ola::rdm::FrequencyModulationSetting, and ola::rdm::BasicSetting.


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