Manager::Var Struct Reference

A variable returning a floating-point value for a given Particle. More...

#include <Manager.h>

Inheritance diagram for Manager::Var:

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

Public Attributes
FunctionPtr	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
std::string	functionName
	Name of underlying function.

Detailed Description

A variable returning a floating-point value for a given Particle.

Definition at line 146 of file Manager.h.

Constructor & Destructor Documentation

Var()

Var ( const std::string & n, FunctionPtr f, const std::string & d, const std::string & g = "", const VariableDataType & v = VariableDataType::c_double, const std::string & fName = "" )

inline

ctor

Definition at line 149 of file Manager.h.

          : VarBase(n, d, g, v, fName), 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 130 of file Manager.h.

function

FunctionPtr function

Pointer to function.

Definition at line 147 of file Manager.h.

functionName

std::string functionName

inherited

Name of underlying function.

Definition at line 133 of file Manager.h.

group

std::string group

inherited

Associated group.

Definition at line 131 of file Manager.h.

name

std::string name

inherited

Unique identifier of the function, used as key.

Definition at line 129 of file Manager.h.

variabletype

VariableDataType variabletype

inherited

data type of variable

Definition at line 132 of file Manager.h.

---

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

• analysis/VariableManager/include/Manager.h