FourStepLoopParams Class Reference

Public Member Functions
bool	validSettings () const
uint	maxIterations () const
void	setMaxIterations (const uint &iMaxIterations)
double	maxDemandSupplyGap () const
void	setMaxDemandSupplyGap (double maxDemandSupplyGap)
LoopObjectData	getObjectExitCondition (const EDataObjectType &iType) const
void	setObjectExitCondition (const EDataObjectType &iType, const LoopObjectData &iExitCondition)
void	removeObjectExitCondition (const EDataObjectType &iType)

Member Function Documentation

getObjectExitCondition()

LoopObjectData FourStepLoopParams::getObjectExitCondition

(

const EDataObjectType &

iType

)

const

Gets the exit condition associated to iType

maxDemandSupplyGap()

double FourStepLoopParams::maxDemandSupplyGap

(

)

const

Gets the maximum demand-supply gap

maxIterations()

uint FourStepLoopParams::maxIterations

(

)

const

Gets the maximum number of iterations

removeObjectExitCondition()

void FourStepLoopParams::removeObjectExitCondition

(

const EDataObjectType &

iType

)

Removes the exit condition associated to iType

setMaxDemandSupplyGap()

void FourStepLoopParams::setMaxDemandSupplyGap

(

double

maxDemandSupplyGap

)

Sets the maximum demand-supply gap

setMaxIterations()

void FourStepLoopParams::setMaxIterations

(

const uint &

iMaxIterations

)

Sets the maximum number of iterations

setObjectExitCondition()

void FourStepLoopParams::setObjectExitCondition	(	const EDataObjectType &	iType,
		const LoopObjectData &	iExitCondition
	)

Sets the exit condition associated to iType

validSettings()

bool FourStepLoopParams::validSettings

(

)

const

Check whether the specified parameters are valid or not