MonitoredVariable Struct Reference

#include <SensitivityInput.h>

Inheritance diagram for MonitoredVariable:

Public Member Functions
	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

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

Monitored variable descriptor

Constructor & Destructor Documentation

MonitoredVariable()

MonitoredVariable::MonitoredVariable	(	std::string	fullTag,
		std::string	unit,
		std::string	label
	)

Member Function Documentation

fullTag()

const std::string & MonitoredVariable::fullTag

(

void

)

const

Returns

the complete path to the variable

json()

std::string MonitoredVariable::json

(

void

)

const

Returns

UTF-8 encoded string with the JSON-serialized object

label()

const std::string & MonitoredVariable::label

(

void

)

const

Returns

the UTF-8 encoded descriptive label

operator==()

bool MonitoredVariable::operator==

(

const MonitoredVariable &

rhs

)

const

Returns

true if the MonitoredVariable object is equal to the rhs

Remarks

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

print_()

std::ostream & MonitoredVariable::print_

(

std::ostream &

os

)

const

informative print

unit()

const std::string & MonitoredVariable::unit

(

void

)

const

Returns

the UTF-8 encoded units of measurement

Member Data Documentation

fullTag_

std::string MonitoredVariable::fullTag_

protected

mandatory complete path to the variable

label_

std::string MonitoredVariable::label_

protected

optional UTF-8 encoded string with a descriptive label

unit_

std::string MonitoredVariable::unit_

protected

optional UTF-8 encoded units of measurement, if omitted will use SI

---

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

• SensitivityInput.h