StochasticPathChoice (planit-all 0.3.0 API)

java.lang.Object
- org.goplanit.component.PlanitComponent<PathChoice>
- - org.goplanit.path.choice.PathChoice
  - - org.goplanit.path.choice.StochasticPathChoice

All Implemented Interfaces:

Serializable, Cloneable, 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)`	Copy constructor
	`StochasticPathChoice(IdGroupingToken groupId)`	Constructor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract StochasticPathChoice`	`clone()`	Create a shallow copy of this entity
`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

Methods inherited from class org.goplanit.component.PlanitComponent
equals, getComponentType, getExternalId, getId, getIdGroupingToken, getKnownSupportedEventTypes, getXmlId, hashCode, onPlanitComponentEvent, reset, setExternalId, setXmlId

Methods inherited from class java.lang.Object
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
hasExternalId, hasXmlId

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)
```
    Copy constructor
    
    Parameters:
    
    other - to copy
- 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
  - clone
```
public abstract StochasticPathChoice clone()
```
    Create a shallow copy of this entity
    
    Specified by:
    
    clone in interface IdAble
    
    Specified by:
    
    clone in class PathChoice
    
    Returns:
    
    shallow copy of entity