ola::BoolVariable Class Reference

Detailed Description

A boolean variable.

Inheritance diagram for ola::BoolVariable:

Collaboration diagram for ola::BoolVariable:

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

Constructor & Destructor Documentation

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

inlineexplicit

Create a new BoolVariable.

Parameters

name	the 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

value

the 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:

• include/ola/ExportMap.h