UncertaintyIF Class Reference

Uncertain parameter class. More...

#include <Uncertainty.hpp>

Public Member Functions
	UncertaintyIF (string name, uint timeStage=1, bool isObservable=true)
	Constructor of the UncertaintyIF class. More...
virtual	~UncertaintyIF ()
	Destructor of the UncertaintyIF class. More...
string	getName () const
	Get the uncertain parameter name. More...
uint	getTimeStage () const
	Return the time-stage when the uncertain parameter is revealed. More...
bool	isObservable () const
	Return indicator of observability, return value equals 1 if and only if the uncertain parameter can be observed. More...
ROCPPUnc_Ptr	Clone ()
	Return a copy of the uncertain parameter. More...

Private Attributes
string	m_name
	Name of the uncertain parameter. More...
uint	m_timeStage
	Time-stage of the uncertain parameter. More...
bool	m_isObservable
	Indicator of observability. It is equal to true if and only if the uncertain parameter can be observed. More...

Detailed Description

Uncertain parameter class.

Constructor & Destructor Documentation

UncertaintyIF()

UncertaintyIF::UncertaintyIF	(	string	name,
		uint	timeStage = 1,
		bool	isObservable = true
	)

Constructor of the UncertaintyIF class.

Parameters

name	name of the uncertain parameter
timeStage	time-stage of the uncertain parameter (time when it is revealed)
isObservable	true if and only if the uncertain parameter is observable

~UncertaintyIF()

virtual UncertaintyIF::~UncertaintyIF ( )

inlinevirtual

Destructor of the UncertaintyIF class.

Member Function Documentation

Clone()

ROCPPUnc_Ptr UncertaintyIF::Clone

(

)

Return a copy of the uncertain parameter.

getName()

string UncertaintyIF::getName ( ) const

inline

Get the uncertain parameter name.

Returns

name of the uncertain parameter, string type

getTimeStage()

uint UncertaintyIF::getTimeStage ( ) const

inline

Return the time-stage when the uncertain parameter is revealed.

Returns

time-stage, uint type

isObservable()

bool UncertaintyIF::isObservable ( ) const

inline

Return indicator of observability, return value equals 1 if and only if the uncertain parameter can be observed.

Returns

observability indicator, boolean type

Note

If an uncertain parameter is observable and its time-stage is t, then all decisions taken on or after time t will be allowed to depend on this uncertain parameter

Member Data Documentation

m_isObservable

bool UncertaintyIF::m_isObservable

private

Indicator of observability. It is equal to true if and only if the uncertain parameter can be observed.

m_name

string UncertaintyIF::m_name

private

Name of the uncertain parameter.

m_timeStage

uint UncertaintyIF::m_timeStage

private

Time-stage of the uncertain parameter.

Note

The time-stage only matters in the case of observable uncertain parameters. If an uncertain parameter is not observable, then its time-stage is not used.