Package org.goplanit.path.choice

Class StochasticPathChoice

java.lang.Object

org.goplanit.component.PlanitComponent<PathChoice>

org.goplanit.path.choice.PathChoice

org.goplanit.path.choice.StochasticPathChoice

All Implemented Interfaces:

Serializable, Comparable<IdAble>, EventListener, PlanitComponentListener, EventListener, ExternalIdAble, IdAble

public abstract class StochasticPathChoice
extends PathChoice

Stochastic path choice component. Stochasticity is reflected by the fact that the path choice is applied by means of a logit model, to be configured here. Also, due to being stochastic the path can/must be provided beforehand. This is also configured via this class

Author:

markr

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected LogitChoiceModel	logitChoiceModel	The registered logit choice model
protected OdPathMatrix	odPathSet	The registered od path set instance

Fields inherited from class org.goplanit.path.choice.PathChoice

STOCHASTIC

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StochasticPathChoice(StochasticPathChoice other, boolean deepCopy)	Copy constructor
	StochasticPathChoice(IdGroupingToken groupId)	Constructor

Method Summary

Modifier and Type	Method	Description
abstract StochasticPathChoice	deepClone()	deep clone on planit component should attempt to also update internal dependencies between deep cloned containers where possible
void	setLogitModel(LogitChoiceModel logitChoiceModel)	set the chosen logit model
void	setOdPathMatrix(OdPathMatrix odPathSet)	Register a fixed od path set to use in the form of an ODPathMatrix
abstract StochasticPathChoice	shallowClone()	Create a shallow copy of this entity

Methods inherited from class org.goplanit.component.PlanitComponent

collectSettingsAsKeyValueMap, equals, getComponentType, getExternalId, getId, getIdGroupingToken, getKnownSupportedEventTypes, getXmlId, hashCode, onPlanitComponentEvent, reset, setExternalId, setXmlId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.goplanit.utils.event.EventListener

hasKnownSupportedEventTypes

Methods inherited from interface org.goplanit.utils.id.ExternalIdAble

appendExternalId, appendExternalId, getIdsAsString, getSplitExternalId, getSplitExternalId, hasExternalId, hasXmlId, setXmlId

Methods inherited from interface org.goplanit.utils.id.IdAble

compareTo, idEquals, idHashCode

Field Detail

logitChoiceModel

protected LogitChoiceModel logitChoiceModel

The registered logit choice model

odPathSet

protected OdPathMatrix odPathSet

The registered od path set instance

Constructor Detail

StochasticPathChoice

public StochasticPathChoice(IdGroupingToken groupId)

Constructor

Parameters:

groupId - contiguous id generation within this group for instances of this class

StochasticPathChoice

protected StochasticPathChoice(StochasticPathChoice other,
                               boolean deepCopy)

Copy constructor

Parameters:

other - to copy

deepCopy - when true, create a deep copy, shallow copy otherwise

Method Detail

setLogitModel

public void setLogitModel(LogitChoiceModel logitChoiceModel)

set the chosen logit model

Parameters:

logitChoiceModel - chosen model

setOdPathMatrix

public void setOdPathMatrix(OdPathMatrix odPathSet)

Register a fixed od path set to use in the form of an ODPathMatrix

Parameters:

odPathSet - the fixed od path set in the shape of an od path matrix

shallowClone

public abstract StochasticPathChoice shallowClone()

Create a shallow copy of this entity

Specified by:

shallowClone in interface IdAble

Specified by:

shallowClone in class PathChoice

Returns:

shallow copy of entity

deepClone

public abstract StochasticPathChoice deepClone()

deep clone on planit component should attempt to also update internal dependencies between deep cloned containers where possible

Specified by:

deepClone in interface IdAble

Specified by:

deepClone in class PathChoice

Returns:

deep copy of entity