Open Lighting Architecture: ola::BaseVariable Class Reference

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
Public Member Functions | List of all members
ola::BaseVariable Class Referenceabstract

## Detailed Description

The base variable class.

All other exported variables derive from this.

Inheritance diagram for ola::BaseVariable:

## Public Member Functions
| BaseVariable (const std::string &name)
| Create a new BaseVariable.
virtual | ~BaseVariable ()
const std::string | Name () const
| Return the name of this variable.
virtual const std::string | Value () const =0
| Return the value of the variable as a string.

## Constructor & Destructor Documentation

## ◆ BaseVariable()

ola::BaseVariable::BaseVariable | ( | const std::string & | name | ) |
| inlineexplicit

Create a new BaseVariable.

Parameters

  name | the variable name.

## ◆ ~BaseVariable()

virtual ola::BaseVariable::~BaseVariable | ( |  | ) |
| inlinevirtual

The Destructor.

## Member Function Documentation

## ◆ Name()

const std::string ola::BaseVariable::Name | ( |  | ) | const
| inline

Return the name of this variable.

Returns
  the variable name.

## ◆ Value()

virtual const std::string ola::BaseVariable::Value | ( |  | ) | const
| pure virtual

Return the value of the variable as a string.

Returns
  the value of the variable.

Implemented in ola::BoolVariable, ola::CounterVariable, ola::IntegerVariable, ola::MapVariable< Type >, ola::MapVariable< Type >, ola::MapVariable< int >, ola::MapVariable< std::string >, ola::MapVariable< std::string >, ola::MapVariable< unsigned int >, and ola::StringVariable.

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

- include/ola/ExportMap.h