ControlledVariable Struct Reference

#include <SensitivityInput.h>

Inheritance diagram for ControlledVariable:

Public Member Functions
	ControlledVariable (const std::string &fullTag, const std::string &unit, const std::string &label, double start, double end, int points)
double	increment (void) const
double	value (int localround) const
int	points (void) const
std::ostream &	print_ (std::ostream &os) const
	informative print More...
std::string	json (void) const
bool	operator== (const ControlledVariable &rhs) const
Public Member Functions inherited from MonitoredVariable
	MonitoredVariable (std::string fullTag, std::string unit, std::string label)
const std::string &	fullTag (void) const
const std::string &	unit (void) const
const std::string &	label (void) const
std::ostream &	print_ (std::ostream &os) const
	informative print More...
std::string	json (void) const
bool	operator== (const MonitoredVariable &rhs) const

Additional Inherited Members
Protected Attributes inherited from MonitoredVariable
std::string	fullTag_
	mandatory complete path to the variable More...
std::string	unit_
	optional UTF-8 encoded units of measurement, if omitted will use SI More...
std::string	label_
	optional UTF-8 encoded string with a descriptive label More...

Detailed Description

Controlled variable descriptor

Constructor & Destructor Documentation

ControlledVariable()

ControlledVariable::ControlledVariable	(	const std::string &	fullTag,
		const std::string &	unit,
		const std::string &	label,
		double	start,
		double	end,
		int	points
	)

Member Function Documentation

increment()

double ControlledVariable::increment

(

void

)

const

Returns the controlled variable increment

json()

std::string ControlledVariable::json

(

void

)

const

Returns

UTF-8 encoded string with the JSON-serialized object

operator==()

bool ControlledVariable::operator==

(

const ControlledVariable &

rhs

)

const

Returns

true if the ControlledVariable object is equal to the rhs

Remarks

floating point values (start and end) are checked within a 1E-5 relative tolerance

points()

int ControlledVariable::points

(

void

)

const

Returns

the number of points to be calculated

print_()

std::ostream & ControlledVariable::print_

(

std::ostream &

os

)

const

informative print

value()

double ControlledVariable::value

(

int

localround

)

const

Value of the controlled variable at the localround calculation

Parameters

localround

index of the current point calculation

---

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

• SensitivityInput.h