Open Lighting Architecture  0.9.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups 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:
ola::rdm::SettingInterface

Classes

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.
std::string Description () const
 The text description of this setting.
uint32_t Frequency () const
 returns the frequency for this setting.
unsigned int DescriptionResponseSize () const
unsigned int GenerateDescriptionResponse (uint8_t index, uint8_t *data) const

Additional Inherited Members

- Private Member Functions inherited from ola::rdm::SettingInterface
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.

Constructor & Destructor Documentation

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

Construct a new FrequencyModulationSetting.

Parameters
argthe FrequencyModulationArg for this setting.

Member Function Documentation

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

The text description of this setting.

Returns
the string description of the setting.

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