Package org.goplanit.network.layer.physical

Class LinkSegmentBase<L extends Link>

java.lang.Object

org.goplanit.utils.id.IdAbleImpl

org.goplanit.utils.id.ExternalIdAbleImpl

org.goplanit.graph.GraphEntityImpl

org.goplanit.graph.directed.EdgeSegmentImpl<L>

org.goplanit.network.layer.physical.LinkSegmentBase<L>

All Implemented Interfaces:

Serializable, Comparable<IdAble>, EdgeSegment, GraphEntity, ExternalIdAble, IdAble, ManagedId, LinkSegment

Direct Known Subclasses:

MacroscopicLinkSegmentImpl

public abstract class LinkSegmentBase<L extends Link>
extends EdgeSegmentImpl<L>
implements LinkSegment

Link segment object representing physical links in the network and storing their properties

Author:

gman6028, markr

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected long	linkSegmentId	unique internal identifier
protected int	numberOfLanes	segment's number of lanes
protected double	physicalSpeedLinkKmh	physical maximum speed on the link segment in km/h

Fields inherited from interface org.goplanit.utils.graph.directed.EdgeSegment

EDGE_SEGMENT_ID_CLASS, getDownstreamVertex, getUpstreamVertex

Fields inherited from interface org.goplanit.utils.network.layer.physical.LinkSegment

DEFAULT_MAX_SPEED, DEFAULT_NUMBER_OF_LANES, LINK_SEGMENT_ID_CLASS, MAXIMUM_DENSITY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LinkSegmentBase(LinkSegmentBase<L> other, boolean deepCopy)	Copy constructor
protected	LinkSegmentBase(IdGroupingToken groupId, boolean directionAB)	Constructor
protected	LinkSegmentBase(IdGroupingToken groupId, L parentLink, boolean directionAB)	Constructor

Method Summary

Modifier and Type	Method	Description
abstract LinkSegmentBase<L>	deepClone()	An id entity should always support a deep copy, i.e., all "owned" members will be deep copied when a clone of this instance is created via this call.
Node	getDownstreamVertex()	Get the segment's downstream vertex
long	getLinkSegmentId()	Return id of this instance.
int	getNumberOfLanes()	Collect the number of lanes of this segment
L	getParent()	Collect the parent edge of the segment
double	getPhysicalSpeedLimitKmH()	This is the maximum speed that is physically present and a driver can observe from the signs on the road
Node	getUpstreamVertex()	Get the segment's upstream vertex
protected long	recreateLinkSegmentId(IdGroupingToken tokenId)	recreate the internal link segment id and set it
long	recreateManagedIds(IdGroupingToken tokenId)	Recreate internal ids: id and link segment id
protected void	setLinkSegmentId(long linkSegmentId)	Set the link segment id
LinkSegment	setNumberOfLanes(int numberOfLanes)	Set the number of lanes
LinkSegment	setPhysicalSpeedLimitKmH(double maximumSpeed)	This is the maximum speed that is physically present and a driver can observe from the signs on the road (km/h)
abstract LinkSegmentBase<L>	shallowClone()	Create a shallow copy of this entity

Methods inherited from class org.goplanit.graph.directed.EdgeSegmentImpl

isDirectionAb, removeParentEdge, setParent, validate, validate

Methods inherited from class org.goplanit.graph.GraphEntityImpl

generateAndSetId, generateId, toString

Methods inherited from class org.goplanit.utils.id.ExternalIdAbleImpl

getExternalId, getXmlId, setExternalId, setXmlId

Methods inherited from class org.goplanit.utils.id.IdAbleImpl

equals, generateAndSetId, getId, hashCode, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.goplanit.utils.graph.directed.EdgeSegment

getIdClass, getLengthKm, getOppositeDirectionSegment, getParentName, hasGeometry, hasParent, hasParentName, isAdjacent, isDirectionAb, isParentGeometryInSegmentDirection, removeParentEdge, setParent, validate

Methods inherited from interface org.goplanit.utils.id.ExternalIdAble

appendExternalId, appendExternalId, getExternalId, getIdsAsString, getSplitExternalId, getSplitExternalId, getXmlId, hasExternalId, hasXmlId, setExternalId, setXmlId, setXmlId

Methods inherited from interface org.goplanit.utils.id.IdAble

compareTo, getId, idEquals, idHashCode

Methods inherited from interface org.goplanit.utils.network.layer.physical.LinkSegment

generateLinkSegmentId, getAllowedModes, getAllowedModesFrom, getDownstreamNode, getLinkSegmentIdClass, getParentLink, getUpstreamNode, hasNode, isDownstreamNode, isModeAllowed, isUpstreamNode

Methods inherited from interface org.goplanit.utils.id.ManagedId

resetChildManagedIdEntities

Field Detail

linkSegmentId

protected long linkSegmentId

unique internal identifier

numberOfLanes

protected int numberOfLanes

segment's number of lanes

physicalSpeedLinkKmh

protected double physicalSpeedLinkKmh

physical maximum speed on the link segment in km/h

Constructor Detail

LinkSegmentBase

protected LinkSegmentBase(IdGroupingToken groupId,
                          boolean directionAB)

Constructor

Parameters:

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

directionAB - direction of travel

LinkSegmentBase

protected LinkSegmentBase(IdGroupingToken groupId,
                          L parentLink,
                          boolean directionAB)

Constructor

Parameters:

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

parentLink - parent link of segment

directionAB - direction of travel

LinkSegmentBase

protected LinkSegmentBase(LinkSegmentBase<L> other,
                          boolean deepCopy)

Copy constructor

Parameters:

other - to copy

deepCopy - when true, create a deep copy, shallow copy otherwise

Method Detail

setLinkSegmentId

protected void setLinkSegmentId(long linkSegmentId)

Set the link segment id

Parameters:

linkSegmentId - to use

recreateLinkSegmentId

protected long recreateLinkSegmentId(IdGroupingToken tokenId)

recreate the internal link segment id and set it

Parameters:

tokenId - to use

Returns:

updated id

recreateManagedIds

public long recreateManagedIds(IdGroupingToken tokenId)

Recreate internal ids: id and link segment id

Specified by:

recreateManagedIds in interface ManagedId

Overrides:

recreateManagedIds in class GraphEntityImpl

Parameters:

tokenId - to use (may be null in case managed id entity does not rely on token to recreate its managed id(s))

Returns:

recreated id

getLinkSegmentId

public long getLinkSegmentId()

Return id of this instance. This id is expected to be generated using the org.planit.utils.misc.IdGenerator

Specified by:

getLinkSegmentId in interface LinkSegment

Returns:

link segment id

getParent

public L getParent()

Collect the parent edge of the segment

Specified by:

getParent in interface EdgeSegment

Specified by:

getParent in interface LinkSegment

Overrides:

getParent in class EdgeSegmentImpl<L extends Link>

Returns:

parentEdge

getDownstreamVertex

public Node getDownstreamVertex()

Get the segment's downstream vertex

Specified by:

getDownstreamVertex in interface EdgeSegment

Specified by:

getDownstreamVertex in interface LinkSegment

Returns:

downstream vertex

getUpstreamVertex

public Node getUpstreamVertex()

Get the segment's upstream vertex

Specified by:

getUpstreamVertex in interface EdgeSegment

Specified by:

getUpstreamVertex in interface LinkSegment

Returns:

upstream vertex

getNumberOfLanes

public int getNumberOfLanes()

Collect the number of lanes of this segment

Specified by:

getNumberOfLanes in interface LinkSegment

Returns:

number of lanes

setNumberOfLanes

public LinkSegment setNumberOfLanes(int numberOfLanes)

Set the number of lanes

Specified by:

setNumberOfLanes in interface LinkSegment

Parameters:

numberOfLanes - to set

Returns:

this link segment

setPhysicalSpeedLimitKmH

public LinkSegment setPhysicalSpeedLimitKmH(double maximumSpeed)

This is the maximum speed that is physically present and a driver can observe from the signs on the road (km/h)

Specified by:

setPhysicalSpeedLimitKmH in interface LinkSegment

Parameters:

maximumSpeed - to set

Returns:

this linkSegment

getPhysicalSpeedLimitKmH

public double getPhysicalSpeedLimitKmH()

This is the maximum speed that is physically present and a driver can observe from the signs on the road

Specified by:

getPhysicalSpeedLimitKmH in interface LinkSegment

Returns:

maximumSpeed

shallowClone

public abstract LinkSegmentBase<L> shallowClone()

Create a shallow copy of this entity

Specified by:

shallowClone in interface EdgeSegment

Specified by:

shallowClone in interface GraphEntity

Specified by:

shallowClone in interface IdAble

Specified by:

shallowClone in interface LinkSegment

Overrides:

shallowClone in class EdgeSegmentImpl<L extends Link>

Returns:

shallow copy of entity

deepClone

public abstract LinkSegmentBase<L> deepClone()

An id entity should always support a deep copy, i.e., all "owned" members will be deep copied when a clone of this instance is created via this call. To be used with caution if not called by managed id container related code

Specified by:

deepClone in interface EdgeSegment

Specified by:

deepClone in interface GraphEntity

Specified by:

deepClone in interface IdAble

Specified by:

deepClone in interface LinkSegment

Overrides:

deepClone in class EdgeSegmentImpl<L extends Link>

Returns:

deep copy of entity