Base class for information common to all types of variables. More...

#include <Manager.h>

Inheritance diagram for Manager::VarBase:

Public Member Functions
	VarBase (const std::string &n, const std::string &d, const std::string &g, const VariableDataType &v, const std::string &fName="")
	ctor

void	extendDescriptionString (const std::string &d)
	function to extend the description of the variable

Public Attributes
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

Base class for information common to all types of variables.

Definition at line 128 of file Manager.h.

Constructor & Destructor Documentation

◆ VarBase()

VarBase	(	const std::string &	n,
		const std::string &	d,
		const std::string &	g,
		const VariableDataType &	v,
		const std::string &	fName = "" )

inline

ctor

Definition at line 135 of file Manager.h.

136 : name(n), description(d), group(g), variabletype(v), functionName(fName.empty() ? n : fName) { }

Member Function Documentation

◆ extendDescriptionString()

void extendDescriptionString ( const std::string & d )

inline

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

Description of what this function does.

Definition at line 130 of file Manager.h.

◆ functionName

std::string functionName

Name of underlying function.

Definition at line 133 of file Manager.h.

◆ group

std::string group

Associated group.

Definition at line 131 of file Manager.h.

◆ name

std::string name

Unique identifier of the function, used as key.

Definition at line 129 of file Manager.h.

◆ variabletype

VariableDataType variabletype

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

Public Member Functions

Public Attributes