Package org.goplanit.path.choice

Class PathChoice

java.lang.Object

org.goplanit.component.PlanitComponent<PathChoice>

org.goplanit.path.choice.PathChoice

All Implemented Interfaces:

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

Direct Known Subclasses:

StochasticPathChoice

public abstract class PathChoice
extends PlanitComponent<PathChoice>
implements Serializable

The path choice traffic assignment component responsible for the configuration of the path choice methodology and the path associated with this procedure. All derived classes must adhere to this protected constructors signature as the factory expects a traffic component create listener only

Author:

markr

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	STOCHASTIC	short for stochastic path choice type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
abstract PathChoice	deepClone()	deep clone on planit component should attempt to also update internal dependencies between deep cloned containers where possible
abstract PathChoice	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

STOCHASTIC

public static final String STOCHASTIC

short for stochastic path choice type

Constructor Detail

PathChoice

protected PathChoice(IdGroupingToken groupId)

Constructor

Parameters:

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

PathChoice

protected PathChoice(PathChoice other,
                     boolean deepCopy)

Copy constructor

Parameters:

other - to copy

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

Method Detail

shallowClone

public abstract PathChoice shallowClone()

Create a shallow copy of this entity

Specified by:

shallowClone in interface IdAble

Specified by:

shallowClone in class PlanitComponent<PathChoice>

Returns:

shallow copy of entity

deepClone

public abstract PathChoice 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 PlanitComponent<PathChoice>

Returns:

deep copy of entity