Manager::ParameterVar Struct Reference

A variable taking additional floating-point arguments to influence the behaviour. More...

#include <Manager.h>

Inheritance diagram for Manager::ParameterVar:

Collaboration diagram for Manager::ParameterVar:

Public Member Functions
	ParameterVar (const std::string &n, ParameterFunctionPtr f, const std::string &d, const std::string &g="", const VariableDataType &v=VariableDataType::c_double)
	ctor
void	extendDescriptionString (const std::string &d)
	function to extend the description of the variable

Public Attributes
ParameterFunctionPtr	function
	Pointer to function.
std::string	name
	Unique identifier of the function, used as key.
std::string	description
	Description of what this function does.
std::string	group
	Associated group.
VariableDataType	variabletype
	data type of variable

Detailed Description

A variable taking additional floating-point arguments to influence the behaviour.

Definition at line 155 of file Manager.h.

Constructor & Destructor Documentation

ParameterVar()

ParameterVar ( const std::string &  n, ParameterFunctionPtr  f, const std::string &  d, const std::string &  g = "", const VariableDataType &  v = VariableDataType::c_double  )

inline

ctor

Definition at line 158 of file Manager.h.

          : VarBase(n, d, g, v), function(f) { }

Member Function Documentation

extendDescriptionString()

void extendDescriptionString ( const std::string &  d )

inlineinherited

function to extend the description of the variable

Definition at line 139 of file Manager.h.

        {
          description.append(d);
        }

Member Data Documentation

description

std::string description

inherited

Description of what this function does.

Definition at line 131 of file Manager.h.

function

ParameterFunctionPtr function

Pointer to function.

Definition at line 156 of file Manager.h.

group

std::string group

inherited

Associated group.

Definition at line 132 of file Manager.h.

name

std::string name

inherited

Unique identifier of the function, used as key.

Definition at line 130 of file Manager.h.

variabletype

VariableDataType variabletype

inherited

data type of variable

Definition at line 133 of file Manager.h.

---

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

• analysis/VariableManager/include/Manager.h