SensitivityInput Struct Reference

#include <SensitivityInput.h>

Inheritance diagram for SensitivityInput:

Public Member Functions
	SensitivityInput (std::string name, std::string type, int id, std::string order, double timeout, int startingRound)
	SensitivityInput (void)
std::ostream &	printInputs_ (std::ostream &os) const
	helper function for printing inputs to streams More...
bool	check (void)
const std::string &	type (void) const
	get the type of the model to analyze More...
int	id (void) const
	get the id of the model to analyze More...
int	startingRound (void) const
	get the starting round for the sensitivity More...
void	addControlledVariable (const ControlledVariable &cv)
	add the controlled variable More...
void	addMonitoredVariable (const MonitoredVariable &mv)
	add the monitored variable More...
std::ostream &	print_ (std::ostream &os) const
	informative print More...
std::string	json (void) const
bool	operator== (const SensitivityInput &rhs) const

Protected Attributes
std::string	name_
	optional UTF-encoded string with a descriptive name More...
std::string	type_
	mandatory UTF-encoded string with the type of the model to analyze More...
int	id_
	mandatory non-negative integer, id of the model to analyze More...
std::string	order_
	mandatory order of execution, can be: lexicographic, boustrophedon or quasi-spiral More...
double	timeout_
	optional maximum running time in seconds (to be enforced by the client) More...
int	startingRound_
	mandatory non-negative integer, valud of the sequential counter based on the chosen ordering More...
std::vector< ControlledVariable >	controlled_
	Controlled variables: at least one. More...
std::vector< MonitoredVariable >	monitored_
	Monitored variables. More...

Detailed Description

Sensitivity input descriptor

Constructor & Destructor Documentation

SensitivityInput() [1/2]

SensitivityInput::SensitivityInput	(	std::string	name,
		std::string	type,
		int	id,
		std::string	order,
		double	timeout,
		int	startingRound
	)

SensitivityInput() [2/2]

SensitivityInput::SensitivityInput

(

void

)

Member Function Documentation

addControlledVariable()

void SensitivityInput::addControlledVariable

(

const ControlledVariable &

cv

)

add the controlled variable

addMonitoredVariable()

void SensitivityInput::addMonitoredVariable

(

const MonitoredVariable &

mv

)

add the monitored variable

check()

bool SensitivityInput::check

(

void

)

verify inputs are available for the sensitivity to be run: non-empty type_ string, positive id_, at least one controlled_ and one monitored_ variable

id()

int SensitivityInput::id

(

void

)

const

get the id of the model to analyze

json()

std::string SensitivityInput::json

(

void

)

const

Returns

UTF-8 encoded string with the JSON-serialized object

operator==()

bool SensitivityInput::operator==

(

const SensitivityInput &

rhs

)

const

Returns

true if the SensitivityInput object is equal to the rhs

print_()

std::ostream & SensitivityInput::print_

(

std::ostream &

os

)

const

informative print

printInputs_()

std::ostream & SensitivityInput::printInputs_

(

std::ostream &

os

)

const

helper function for printing inputs to streams

startingRound()

int SensitivityInput::startingRound

(

void

)

const

get the starting round for the sensitivity

type()

const std::string & SensitivityInput::type

(

void

)

const

get the type of the model to analyze

Member Data Documentation

controlled_

std::vector<ControlledVariable> SensitivityInput::controlled_

protected

Controlled variables: at least one.

id_

int SensitivityInput::id_

protected

mandatory non-negative integer, id of the model to analyze

monitored_

std::vector<MonitoredVariable> SensitivityInput::monitored_

protected

Monitored variables.

name_

std::string SensitivityInput::name_

protected

optional UTF-encoded string with a descriptive name

order_

std::string SensitivityInput::order_

protected

mandatory order of execution, can be: lexicographic, boustrophedon or quasi-spiral

startingRound_

int SensitivityInput::startingRound_

protected

mandatory non-negative integer, valud of the sequential counter based on the chosen ordering

timeout_

double SensitivityInput::timeout_

protected

optional maximum running time in seconds (to be enforced by the client)

type_

std::string SensitivityInput::type_

protected

mandatory UTF-encoded string with the type of the model to analyze

---

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

• SensitivityInput.h