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::ExportMap Class Reference

Detailed Description

A container for the exported variables.

Public Member Functions

BoolVariableGetBoolVar (const std::string &name)
 Lookup or create a BoolVariable. More...
 
IntegerVariableGetIntegerVar (const std::string &name)
 Lookup or create an IntegerVariable. More...
 
CounterVariableGetCounterVar (const std::string &name)
 Lookup or create a CounterVariable. More...
 
StringVariableGetStringVar (const std::string &name)
 Lookup or create a StringVariable. More...
 
StringMapGetStringMapVar (const std::string &name, const std::string &label="")
 
IntMapGetIntMapVar (const std::string &name, const std::string &label="")
 
UIntMapGetUIntMapVar (const std::string &name, const std::string &label="")
 
std::vector< BaseVariable * > AllVariables () const
 Fetch a list of all known variables. More...
 

Member Function Documentation

vector< BaseVariable * > ola::ExportMap::AllVariables ( ) const

Fetch a list of all known variables.

Returns
a vector of all variables.
BoolVariable * ola::ExportMap::GetBoolVar ( const std::string &  name)

Lookup or create a BoolVariable.

Parameters
namethe name of this variable.
Returns
a pointer to the BoolVariable.

The variable is created if it doesn't already exist. The pointer is valid for the lifetime of the ExportMap.

CounterVariable * ola::ExportMap::GetCounterVar ( const std::string &  name)

Lookup or create a CounterVariable.

Parameters
namethe name of this variable.
Returns
a CounterVariable.

The variable is created if it doesn't already exist. The pointer is valid for the lifetime of the ExportMap.

IntegerVariable * ola::ExportMap::GetIntegerVar ( const std::string &  name)

Lookup or create an IntegerVariable.

Parameters
namethe name of this variable.
Returns
an IntegerVariable.

The variable is created if it doesn't already exist. The pointer is valid for the lifetime of the ExportMap.

StringVariable * ola::ExportMap::GetStringVar ( const std::string &  name)

Lookup or create a StringVariable.

Parameters
namethe name of this variable.
Returns
a StringVariable.

The variable is created if it doesn't already exist. The pointer is valid for the lifetime of the ExportMap.


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