Package org.planit.cost.physical

Class PhysicalCost

java.lang.Object

org.djutils.event.EventProducer

org.planit.trafficassignment.TrafficAssignmentComponent<PhysicalCost>

org.planit.cost.physical.PhysicalCost

All Implemented Interfaces:

Serializable, org.djutils.event.EventProducerInterface, Cost<LinkSegment>, AbstractPhysicalCost

Direct Known Subclasses:

BPRLinkTravelTimeCost

public abstract class PhysicalCost
extends TrafficAssignmentComponent<PhysicalCost>
implements AbstractPhysicalCost

Class for dynamic cost functions, which calculate link segment costs for each iteration

Author:

markr, gman6028

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	BPR	short hand for configuring physical cost with BPR function instance

Fields inherited from class org.planit.trafficassignment.TrafficAssignmentComponent

groupId, id, 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

Modifier	Constructor	Description
protected	PhysicalCost(IdGroupingToken groupId)

Method Summary

Modifier and Type	Method	Description
abstract void	initialiseBeforeSimulation(PhysicalNetwork physicalNetwork)	Initialize the cost parameter values in the network

Methods inherited from class org.planit.trafficassignment.TrafficAssignmentComponent

getId, getIdGroupingtoken, getSourceId, getTrafficComponentType

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.planit.cost.Cost

getSegmentCost

Field Detail

BPR

public static final String BPR

short hand for configuring physical cost with BPR function instance

Constructor Detail

PhysicalCost

protected PhysicalCost(IdGroupingToken groupId)

Parameters:

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

Method Detail

initialiseBeforeSimulation

public abstract void initialiseBeforeSimulation(PhysicalNetwork physicalNetwork)
                                         throws PlanItException

Initialize the cost parameter values in the network

Parameters:

physicalNetwork - the physical network

Throws:

PlanItException - thrown if a link/mode combination exists for which no cost parameters have been set