Package org.goplanit.utils.network.layer.physical

Interface LinkSegment

All Superinterfaces:

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

All Known Subinterfaces:

MacroscopicLinkSegment

All Known Implementing Classes:

LinkSegmentImpl, MacroscopicLinkSegmentImpl

public interface LinkSegment
extends EdgeSegment

Interface for link segments (directional) part of link (non-directional).

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
static double	DEFAULT_MAX_SPEED	Default maximum speed on a link segment in km/h
static short	DEFAULT_NUMBER_OF_LANES	Default number of lanes
static Class<LinkSegment>	LINK_SEGMENT_ID_CLASS	additional id class for generating link segment ids
static double	MAXIMUM_DENSITY	Default maximum link density in pcu/km

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

EDGE_SEGMENT_ID_CLASS

Method Summary

Modifier and Type	Method	Description
default Node	getDownstreamNode()	Collect downstream vertex as node
Node	getDownstreamVertex()	Get the segment's downstream vertex
long	getLinkSegmentId()	Return id of this instance.
default Class<? extends LinkSegment>	getLinkSegmentIdClass()	Return class used to generate unique link ids via the id generator
int	getNumberOfLanes()	Collect the number of lanes of this segment
Link	getParentEdge()	Collect the parent edge of the segment
default Link	getParentLink()	Return the parent link of this link segment
double	getPhysicalSpeedLimitKmH()	This is the maximum speed (Km/h) that is physically present and a driver can observe from the signs on the road
default Node	getUpstreamNode()	Collect upstream vertex as node
Node	getUpstreamVertex()	Get the segment's upstream vertex
void	setNumberOfLanes(int numberOfLanes)	Set the number of lanes
void	setPhysicalSpeedLimitKmH(double maximumSpeedKmH)	This is the maximum speed that is physically present and a driver can observe from the signs on the road (km/h)

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

clone, getIdClass, getParentName, hasParentName, isDirectionAb, remove, removeParentEdge, replace, setDownstreamVertex, setParent, setUpstreamVertex, validate

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

getExternalId, getXmlId, hasExternalId, hasXmlId, setExternalId, setXmlId

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

compareTo, getId, idEquals, idHashCode

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

recreateManagedIds, resetChildManagedIdEntities

Field Detail

LINK_SEGMENT_ID_CLASS

static final Class<LinkSegment> LINK_SEGMENT_ID_CLASS

additional id class for generating link segment ids

DEFAULT_NUMBER_OF_LANES

static final short DEFAULT_NUMBER_OF_LANES

Default number of lanes

See Also:

Constant Field Values

DEFAULT_MAX_SPEED

static final double DEFAULT_MAX_SPEED

Default maximum speed on a link segment in km/h

See Also:

Constant Field Values

MAXIMUM_DENSITY

static final double MAXIMUM_DENSITY

Default maximum link density in pcu/km

See Also:

Constant Field Values

Method Detail

getLinkSegmentIdClass

default Class<? extends LinkSegment> getLinkSegmentIdClass()

Return class used to generate unique link ids via the id generator

Returns:

class type

getLinkSegmentId

long getLinkSegmentId()

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

Returns:

link segment id

getNumberOfLanes

int getNumberOfLanes()

Collect the number of lanes of this segment

Returns:

number of lanes

setNumberOfLanes

void setNumberOfLanes(int numberOfLanes)

Set the number of lanes

Parameters:

numberOfLanes - to set

setPhysicalSpeedLimitKmH

void setPhysicalSpeedLimitKmH(double maximumSpeedKmH)

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

Parameters:

maximumSpeedKmH - to set

getPhysicalSpeedLimitKmH

double getPhysicalSpeedLimitKmH()

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

Returns:

maximumSpeedKmH

getParentEdge

Link getParentEdge()

Collect the parent edge of the segment

Specified by:

getParentEdge in interface EdgeSegment

Returns:

parentEdge

getUpstreamVertex

Node getUpstreamVertex()

Get the segment's upstream vertex

Specified by:

getUpstreamVertex in interface EdgeSegment

Returns:

upstream vertex

getDownstreamVertex

Node getDownstreamVertex()

Get the segment's downstream vertex

Specified by:

getDownstreamVertex in interface EdgeSegment

Returns:

downstream vertex

getParentLink

default Link getParentLink()

Return the parent link of this link segment

Returns:

Link object which is the parent of this link segment

getUpstreamNode

default Node getUpstreamNode()

Collect upstream vertex as node

Returns:

upstream node

getDownstreamNode

default Node getDownstreamNode()

Collect downstream vertex as node

Returns:

downstream node