Package org.goplanit.cost

Interface Cost<T extends EdgeSegment>

All Known Subinterfaces:

PhysicalCost, VirtualCost

All Known Implementing Classes:

AbstractPhysicalCost, AbstractVirtualCost, BPRLinkTravelTimeCost, FixedConnectoidTravelTimeCost, FreeFlowLinkTravelTimeCost, InitialLinkSegmentCost, InitialModesLinkSegmentCost, InitialPhysicalCost, ManualInitialLinkSegmentCost, SpeedConnectoidTravelTimeCost, SteadyStateTravelTimeCost

public interface Cost<T extends EdgeSegment>

Cost of an EdgeSegment

Author:

markr

Method Summary

Modifier and Type	Method	Description
double	getDTravelTimeDFlow(boolean uncongested, Mode mode, T edgeSegment)	Get the first derivative of the used travel time computation method towards the edge segment (in) flow rate in PCU per hour, i.e.
double	getGeneralisedCost(Mode mode, T edgeSegment)	Returns the generalised cost of travel along an edge segment for a specified mode
double	getTravelTimeCost(Mode mode, T edgeSegment)	Returns the generalised cost of travel along an edge segment for a specified mode

Method Detail

getGeneralisedCost

double getGeneralisedCost(Mode mode,
                          T edgeSegment)

Returns the generalised cost of travel along an edge segment for a specified mode

Parameters:

mode - the specified mode of travel

edgeSegment - the specified edge segment (which can be physical or virtual)

Returns:

the cost of travel along the specified segment

getTravelTimeCost

double getTravelTimeCost(Mode mode,
                         T edgeSegment)

Returns the generalised cost of travel along an edge segment for a specified mode

Parameters:

mode - the specified mode of travel

edgeSegment - the specified edge segment (which can be physical or virtual)

Returns:

the cost of travel along the specified segment

getDTravelTimeDFlow

double getDTravelTimeDFlow(boolean uncongested,
                           Mode mode,
                           T edgeSegment)

Get the first derivative of the used travel time computation method towards the edge segment (in) flow rate in PCU per hour, i.e. dTraveltime//dFlow.

Parameters:

uncongested - flag idicating if the provided flow is uncongested or congested flow, relevant when flow can represent multiple traffic states

mode - to use

edgeSegment - to use

Returns:

the first derivative of travel time for a unit flow rate change in PCU per Hour