Package org.planit.path.choice

Class StochasticPathChoice

java.lang.Object

org.djutils.event.EventProducer

org.planit.assignment.TrafficAssignmentComponent<PathChoice>

org.planit.path.choice.PathChoice

org.planit.path.choice.StochasticPathChoice

All Implemented Interfaces:

Serializable, Comparable<Idable>, org.djutils.event.EventProducerInterface, Idable

public 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.planit.path.choice.PathChoice

STOCHASTIC

Fields inherited from class org.planit.assignment.TrafficAssignmentComponent

id, tokenId, trafficComponentType

Fields inherited from class org.djutils.event.EventProducer

listeners

Fields inherited from interface org.djutils.event.EventProducerInterface

FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors

Constructor	Description
StochasticPathChoice(IdGroupingToken groupId)	Constructor

Method Summary

Modifier and Type	Method	Description
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.planit.assignment.TrafficAssignmentComponent

equals, getId, getIdGroupingToken, getSourceId, getTrafficComponentType, hashCode

Methods inherited from class org.djutils.event.EventProducer

addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, getEventTypesWithListeners, hasListeners, numberOfListeners, removeAllListeners, removeAllListeners, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.planit.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

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