Open Lighting Architecture: ola::rdm::SettingInterface Class Reference

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
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:

## Public Member Functions
virtual std::string | Description () const =0
| The text description of this setting.
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.

## Member Function Documentation

## ◆ Description()

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::BasicSetting, and ola::rdm::FrequencyModulationSetting.

## ◆ DescriptionResponseSize()

virtual unsigned int ola::rdm::SettingInterface::DescriptionResponseSize | ( |  | ) | const
| pure virtual

Return the size of the _DESCRIPTION parameter data.

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

## ◆ GenerateDescriptionResponse()

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

Populate the _DESCRIPTION parameter data.

Parameters

  index | the index for this setting
  data | the RDM parameter data to write to.

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

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

- include/ola/rdm/ResponderSettings.h