Package org.planit.utils.network.physical.macroscopic

Interface MacroscopicLinkSegment

All Superinterfaces:

Comparable<EdgeSegment>, EdgeSegment, LinkSegment, Serializable

All Known Implementing Classes:

MacroscopicLinkSegmentImpl

public interface MacroscopicLinkSegment
extends LinkSegment

Macroscopic traffic modeling oriented link segment

Author:

markr

Field Summary

Fields inherited from interface org.planit.utils.network.physical.LinkSegment

DEFAULT_MAX_SPEED, DEFAULT_NUMBER_OF_LANES, MAXIMUM_DENSITY

Method Summary

Modifier and Type	Method	Description
double	computeCapacity()	Return the total link segment capacity in pcu/h
double	computeFreeFlowTravelTime(Mode mode)	Compute the free flow travel time by mode, i.e.
MacroscopicLinkSegmentType	getLinkSegmentType()	Collect the link segment type of the link segment
void	setLinkSegmentType(MacroscopicLinkSegmentType linkSegmentType)	Set the link segment type this link segment adheres to

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.planit.utils.graph.EdgeSegment

getDownstreamVertex, getExternalId, getId, getParentEdge, getUpstreamVertex, hasExternalId, setExternalId

Methods inherited from interface org.planit.utils.network.physical.LinkSegment

getLinkSegmentId, getMaximumSpeed, getNumberOfLanes, getParentLink, isModeAllowedThroughLink, setMaximumSpeed, setNumberOfLanes

Method Detail

computeCapacity

double computeCapacity()

Return the total link segment capacity in pcu/h

Returns:

linkSegmentCapacity in PCU/h

computeFreeFlowTravelTime

double computeFreeFlowTravelTime(Mode mode)
                          throws PlanItException

Compute the free flow travel time by mode, i.e. when the link's maximum speed might be capped by the mode's maximum speed If the input data are invalid, this method logs the problem and returns a negative value.

Parameters:

mode - mode of travel

Returns:

freeFlowTravelTime for this mode

Throws:

PlanItException - thrown if error

setLinkSegmentType

void setLinkSegmentType(MacroscopicLinkSegmentType linkSegmentType)

Set the link segment type this link segment adheres to

Parameters:

linkSegmentType - the link segment type

getLinkSegmentType

MacroscopicLinkSegmentType getLinkSegmentType()

Collect the link segment type of the link segment

Returns:

the link segment