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

Detailed Description

A boolean variable.

Inheritance diagram for ola::BoolVariable:
Inheritance graph
[legend]
Collaboration diagram for ola::BoolVariable:
Collaboration graph
[legend]

Public Member Functions

 BoolVariable (const std::string &name)
 Create a new BoolVariable. More...
 
void Set (bool value)
 Set the value of the variable. More...
 
bool Get () const
 Get the value of this variable. More...
 
const std::string Value () const
 Get the value of this variable as a string. More...
 
- Public Member Functions inherited from ola::BaseVariable
 BaseVariable (const std::string &name)
 Create a new BaseVariable. More...
 
virtual ~BaseVariable ()
 
const std::string Name () const
 Return the name of this variable. More...
 

Constructor & Destructor Documentation

ola::BoolVariable::BoolVariable ( const std::string &  name)
inlineexplicit

Create a new BoolVariable.

Parameters
namethe variable name.

Member Function Documentation

bool ola::BoolVariable::Get ( ) const
inline

Get the value of this variable.

Returns
the value of the boolean variable.
void ola::BoolVariable::Set ( bool  value)
inline

Set the value of the variable.

Parameters
valuethe new value.
const std::string ola::BoolVariable::Value ( ) const
inlinevirtual

Get the value of this variable as a string.

Returns
the value of the boolean variable.

Booleans are represented by a 1 or 0.

Implements ola::BaseVariable.


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