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

Detailed Description

A PWM Frequency Setting. See Section 4.10 of E1.37-1.

Inheritance diagram for ola::rdm::FrequencyModulationSetting:
Inheritance graph
Collaboration diagram for ola::rdm::FrequencyModulationSetting:
Collaboration graph


struct  FrequencyModulationArg
 The constructor argument for the FrequencyModulationSetting. More...

Public Types

typedef FrequencyModulationArg ArgType

Public Member Functions

 FrequencyModulationSetting (const ArgType &arg)
 Construct a new FrequencyModulationSetting. More...
std::string Description () const
 The text description of this setting. More...
uint32_t Frequency () const
 returns the frequency for this setting.
unsigned int DescriptionResponseSize () const
 Return the size of the _DESCRIPTION parameter data.
unsigned int GenerateDescriptionResponse (uint8_t index, uint8_t *data) const
 Populate the _DESCRIPTION parameter data. More...

Constructor & Destructor Documentation

ola::rdm::FrequencyModulationSetting::FrequencyModulationSetting ( const ArgType arg)

Construct a new FrequencyModulationSetting.

argthe FrequencyModulationArg for this setting.

Member Function Documentation

std::string ola::rdm::FrequencyModulationSetting::Description ( ) const

The text description of this setting.

the string description of the setting.

Implements ola::rdm::SettingInterface.

unsigned int ola::rdm::FrequencyModulationSetting::GenerateDescriptionResponse ( uint8_t  index,
uint8_t *  data 
) const

Populate the _DESCRIPTION parameter data.

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

Implements ola::rdm::SettingInterface.

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