Open Lighting Architecture
 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::BasicSetting Class Reference

Detailed Description

A Setting which has a description and no other properties.

Inheritance diagram for ola::rdm::BasicSetting:
ola::rdm::SettingInterface

Classes

struct  description_s

Public Types

typedef const char * ArgType

Public Member Functions

 BasicSetting (const ArgType description)
 Construct a new BasicSetting.
string Description () const
 The text description of 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 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::BasicSetting::BasicSetting ( const ArgType  description)
explicit

Construct a new BasicSetting.

Parameters
descriptionthe description for this setting.

Member Function Documentation

string ola::rdm::BasicSetting::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: