PyMacroModelPlugin.MacroExperimentParams¶

class MacroExperimentParams¶

MacroExperiment parameters

Synopsis¶

Methods¶

def __init__()

Virtual methods¶

def getBiCriteriaEnabled()
def getPreloadExperiment()
def getSectionTollAttr()
def getTurningTollAttr()
def getTypeName()
def resetTollAttributes()
def setBiCriteriaEnabled()
def setPreloadExperiment()
def setSectionTollAttr()
def setTurningTollAttr()
def validParameters()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

__init__()¶

getBiCriteriaEnabled()¶

Return type:: bool

Gets if Bi-Criteria is enabled or not @remark Only FrankWolfe , AllOrNothing and MSA assignments can be enabled, for all other it will return false always.

getPreloadExperiment()¶

Return type:: MacroExperiment

getSectionTollAttr(user)¶

Parameters:: user – GKUserClass
Return type:: GKColumn

Gets the Section Toll Attribute for a user

getTurningTollAttr(user)¶

Parameters:: user – GKUserClass
Return type:: GKColumn

Gets the Turn Toll Attribute for a user

abstractmethod getTypeName()¶

Return type:: str

Get the type name

resetTollAttributes()¶

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

setBiCriteriaEnabled(enabled)¶

Parameters:: enabled – bool

Enables/Disables Bi-Criteria @remark Only FrankWolfe , AllOrNothing and MSA assignments can be enabled.

setPreloadExperiment(experiment)¶

Parameters:: experiment – MacroExperiment

setSectionTollAttr(user, col)¶

Parameters:

user – GKUserClass
col – GKColumn

Sets the Section Toll Attribute for a user @remark The column needs to be of numeric type ( Int , UInt , Double ).

setTurningTollAttr(user, col)¶

Parameters:

user – GKUserClass
col – GKColumn

Sets the Turn Toll Attribute for a user @remark The column needs to be of numeric type ( Int , UInt , Double ).

abstractmethod validParameters(iModel)¶

Parameters:: iModel – GKModel
Return type:: bool