MacroExperimentParams Class Reference

Inheritance diagram for MacroExperimentParams:

Public Member Functions
	if (base)
Py_END_ALLOW_THREADS End	MacroExperimentParams ()
	~MacroExperimentParams ()
virtual QString	getTypeName () const =0
virtual bool	validParameters (GKModel *iModel) const =0
virtual bool	getBiCriteriaEnabled () const
virtual GKColumn *	getSectionTollAttr (const GKUserClass *user) const
virtual GKColumn *	getTurningTollAttr (const GKUserClass *user) const
virtual void	setBiCriteriaEnabled (bool enabled)
virtual void	resetTollAttributes ()
virtual void	setSectionTollAttr (const GKUserClass *user, GKColumn *col)
virtual void	setTurningTollAttr (const GKUserClass *user, GKColumn *col)

Public Attributes
ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS MacroExperimentParams *	base = (MacroExperimentParams*)sipCpp
	sipType = 0

Detailed Description

MacroExperiment parameters

Constructor & Destructor Documentation

MacroExperimentParams()

Py_END_ALLOW_THREADS End MacroExperimentParams::MacroExperimentParams

(

)

Constructor of the MacroExperimentParams

~MacroExperimentParams()

MacroExperimentParams::~MacroExperimentParams

(

)

Destructor of the MacroExperimentParams

Member Function Documentation

getBiCriteriaEnabled()

virtual bool MacroExperimentParams::getBiCriteriaEnabled ( ) const

virtual

Gets if Bi-Criteria is enabled or not

Remarks

Only FrankWolfe, AllOrNothing and MSA assignments can be enabled, for all other it will return false always.

getSectionTollAttr()

virtual GKColumn * MacroExperimentParams::getSectionTollAttr ( const GKUserClass *  user ) const

virtual

Gets the Section Toll Attribute for a user.

getTurningTollAttr()

virtual GKColumn * MacroExperimentParams::getTurningTollAttr ( const GKUserClass *  user ) const

virtual

Gets the Turning Toll Attribute for a user.

getTypeName()

virtual QString MacroExperimentParams::getTypeName ( ) const

pure virtual

Get the type name

Implemented in CFrankWolfeParams, CIncrementalParams, CMSAParams, and CStochasticParams.

Referenced by if().

if()

MacroExperimentParams::if ( base  )

inline

References base, GKSystem::getSystem(), getTypeName(), and sipType.

resetTollAttributes()

virtual void MacroExperimentParams::resetTollAttributes ( )

virtual

Resets the Section and Turning Toll Attributes for all users to the default value (userDefinedCostAtt).

setBiCriteriaEnabled()

virtual void MacroExperimentParams::setBiCriteriaEnabled ( bool  enabled )

virtual

Enables/Disables Bi-Criteria

Remarks

Only FrankWolfe, AllOrNothing and MSA assignments can be enabled.

setSectionTollAttr()

virtual void MacroExperimentParams::setSectionTollAttr ( const GKUserClass *  user, GKColumn *  col  )

virtual

Sets the Section Toll Attribute for a user

Remarks

The column needs to be of numeric type (GKColumn::Int, GKColumn::UInt, GKColumn::Double).

setTurningTollAttr()

virtual void MacroExperimentParams::setTurningTollAttr ( const GKUserClass *  user, GKColumn *  col  )

virtual

Sets the Turning Toll Attribute for a user

Remarks

The column needs to be of numeric type (GKColumn::Int, GKColumn::UInt, GKColumn::Double).

validParameters()

virtual bool MacroExperimentParams::validParameters ( GKModel *  iModel ) const

pure virtual

Implemented in CFrankWolfeParams, CIncrementalParams, CMSAParams, and CStochasticParams.

Member Data Documentation

base

ConvertToSubClassCode Py_BEGIN_ALLOW_THREADS MacroExperimentParams* MacroExperimentParams::base = (MacroExperimentParams*)sipCpp

Referenced by if().

sipType

MacroExperimentParams::sipType = 0

Referenced by if().