engage::Variables Class Reference

This represents all of the variables the user can select for writing. More...

#include <Variables.hpp>

Public Member Functions
	Variables ()

Static Public Member Functions
static size_t	FindRealVariable (const std::string &aName)
static size_t	FindIntegerVariable (const std::string &aName)
static size_t	FindStringVariable (const std::string &aName)
static double	GetScaleFactor (size_t aIndex, const std::string &aUnits)
static double	GetRealValue (size_t aVarIndex, Simulation &aSimulation, size_t aArrayIndex)
static int	GetIntegerValue (size_t aVarIndex, Simulation &aSimulation, size_t aArrayIndex)
static std::string	GetStringValue (size_t aVarIndex, Simulation &aSimulation, size_t aArrayIndex)

Detailed Description

This represents all of the variables the user can select for writing.

Constructor & Destructor Documentation

Variables()

engage::Variables::Variables

(

)

Member Function Documentation

FindIntegerVariable()

size_t engage::Variables::FindIntegerVariable ( const std::string & aName )

static

Find an integer variable definition with the specified name.

Parameters

aName

[input] The name of the variable being requested.

Returns

The variable index (used to access the run-time value of a variable), or 0 if not found.

Referenced by engage::OutputItem::ProcessInput().

FindRealVariable()

size_t engage::Variables::FindRealVariable ( const std::string & aName )

static

Find a real variable definition with the specified name.

Parameters

aName

[input] The name of the variable being requested.

Returns

The variable index (used to access the run-time value of a variable), or 0 if not found.

Referenced by engage::OutputItem::ProcessInput().

FindStringVariable()

size_t engage::Variables::FindStringVariable ( const std::string & aName )

static

Find a string variable definition with the specified name.

Parameters

aName

[input] The name of the variable being requested.

Returns

The variable index (used to access the run-time value of a variable), or 0 if not found.

Referenced by engage::OutputItem::ProcessInput().

GetIntegerValue()

int engage::Variables::GetIntegerValue ( size_t aVarIndex, Simulation & aSimulation, size_t aArrayIndex )

static

Get the current value associated with the specified variable.

Parameters

aVarIndex	[input] The index of the variable whose value is being requested.
aSimulation	[input] The simulation containing the variable.
aArrayIndex	[input] The array index for variables that are arrays.

Returns

The current value of the requested variable.

Referenced by engage::OutputItem::DoOutput().

GetRealValue()

double engage::Variables::GetRealValue ( size_t aVarIndex, Simulation & aSimulation, size_t aArrayIndex )

static

Get the current value associated with the specified variable.

Parameters

aVarIndex	[input] The index of the variable whose value is being requested.
aSimulation	[input] The simulation containing the variable.
aArrayIndex	[input] The array index for variables that are arrays.

Returns

The current value of the requested variable.

Referenced by engage::OutputItem::DoOutput().

GetScaleFactor()

double engage::Variables::GetScaleFactor ( size_t aVarIndex, const std::string & aUnits )

static

Get the scale factor to convert the specified real variable from standard to user-specified units.

Parameters

aVarIndex	[input] Index of the variable.
aUnits	[input] User-specified units.

Referenced by engage::OutputItem::ProcessInput().

GetStringValue()

std::string engage::Variables::GetStringValue ( size_t aVarIndex, Simulation & aSimulation, size_t aArrayIndex )

static

Get the current value associated with the specified variable.

Parameters

aVarIndex	[input] The index of the variable whose value is being requested.
aSimulation	[input] The simulation containing the variable.
aArrayIndex	[input] The array index for variables that are arrays.

Returns

The current value of the requested variable.

Referenced by engage::OutputItem::DoOutput().

---

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

• Variables.hpp
• Variables.cpp