Package org.goplanit.utils.network.virtual

Interface ConjugateConnectoidSegment

All Superinterfaces:

Comparable<IdAble>, ConjugateEdgeSegment, EdgeSegment, ExternalIdAble, GraphEntity, IdAble, ManagedId, PcuCapacitated, Serializable

All Known Implementing Classes:

ConjugateConnectoidSegmentImpl

public interface ConjugateConnectoidSegment
extends ConjugateEdgeSegment, PcuCapacitated

Conjugate connectoid segment represents a directional virtual segment connecting two conjugate connectoid nodes, however, one is a dummy and one of the original underlying link segments is null.

Author:

markr

Field Summary

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

CONJUGATE_EDGE_SEGMENT_ID_CLASS

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

EDGE_SEGMENT_ID_CLASS, getDownstreamVertex, getUpstreamVertex

Method Summary

Modifier and Type	Method	Description
ConjugateConnectoidSegment	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.
default double	getCapacityOrDefaultPcuH()	Connectoid segments are not capacity restricted by default, but can be used in conjunction with a capacitated network.
default double	getCapacityOrDefaultPcuHLane()	see getCapacityOrDefaultPcuH()
default ConjugateConnectoidNode	getDownstreamVertex()	Get the segment's downstream vertex
default Pair<? extends LinkSegment,? extends LinkSegment>	getOriginalAdjcentEdgeSegments()	Adjacent edge segments in original graph for this conjugate
ConjugateConnectoidEdge	getParent()	Collect the parent edge of the segment
default ConjugateConnectoidNode	getUpstreamVertex()	Get the segment's upstream vertex
ConjugateConnectoidSegment	shallowClone()	Create a shallow copy of this entity

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

getIdClass, getOppositeDirectionSegment

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

getLengthKm, 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.id.ManagedId

recreateManagedIds, resetChildManagedIdEntities

Method Detail

shallowClone

ConjugateConnectoidSegment shallowClone()

Create a shallow copy of this entity

Specified by:

shallowClone in interface ConjugateEdgeSegment

Specified by:

shallowClone in interface EdgeSegment

Specified by:

shallowClone in interface GraphEntity

Specified by:

shallowClone in interface IdAble

Returns:

shallow copy of entity

deepClone

ConjugateConnectoidSegment 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 ConjugateEdgeSegment

Specified by:

deepClone in interface EdgeSegment

Specified by:

deepClone in interface GraphEntity

Specified by:

deepClone in interface IdAble

Returns:

deep copy of entity

getCapacityOrDefaultPcuH

default double getCapacityOrDefaultPcuH()

Connectoid segments are not capacity restricted by default, but can be used in conjunction with a capacitated network. Therefore, they by default return Double.MAX_VALUE as their capacity. We have no limitation on capacity to ensure that demand does not get "trapped" in zones, but can at least be loaded onto connectoid segments so it is present in the network during loading

Specified by:

getCapacityOrDefaultPcuH in interface PcuCapacitated

Returns:

capacity in PCu/h

getCapacityOrDefaultPcuHLane

default double getCapacityOrDefaultPcuHLane()

see getCapacityOrDefaultPcuH()

Specified by:

getCapacityOrDefaultPcuHLane in interface PcuCapacitated

Returns:

capacity in PCu/h

getParent

ConjugateConnectoidEdge getParent()

Collect the parent edge of the segment

Specified by:

getParent in interface ConjugateEdgeSegment

Specified by:

getParent in interface EdgeSegment

Returns:

parentEdge

getUpstreamVertex

default ConjugateConnectoidNode getUpstreamVertex()

Get the segment's upstream vertex

Specified by:

getUpstreamVertex in interface ConjugateEdgeSegment

Specified by:

getUpstreamVertex in interface EdgeSegment

Returns:

upstream vertex

getDownstreamVertex

default ConjugateConnectoidNode getDownstreamVertex()

Get the segment's downstream vertex

Specified by:

getDownstreamVertex in interface ConjugateEdgeSegment

Specified by:

getDownstreamVertex in interface EdgeSegment

Returns:

downstream vertex

getOriginalAdjcentEdgeSegments

default Pair<? extends LinkSegment,? extends LinkSegment> getOriginalAdjcentEdgeSegments()

Adjacent edge segments in original graph for this conjugate

Specified by:

getOriginalAdjcentEdgeSegments in interface ConjugateEdgeSegment

Returns:

edge segment pair