Package org.goplanit.utils.network.virtual

Interface ConnectoidSegment

All Superinterfaces:

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

All Known Implementing Classes:

ConnectoidSegmentImpl

public interface ConnectoidSegment
extends EdgeSegment, PcuCapacitated

Connectoid segment represents a directional virtual segment connecting a centroid and a physical node. It has a unique id across all connectoid segments

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
static Class<ConnectoidSegment>	CONNECTOID_SEGMENT_ID_CLASS	additional id class for generating connectoid segment ids

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

EDGE_SEGMENT_ID_CLASS, getDownstreamVertex, getUpstreamVertex

Method Summary

Modifier and Type	Method	Description
ConnectoidSegment	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()
long	getConnectoidSegmentId()	Collect the unqiue connectoid segment id
default Class<ConnectoidSegment>	getConnectoidSegmentIdClass()	Return class used to generate unique connectoid edge segment ids via the id generator
ConnectoidSegment	shallowClone()	Create a shallow copy of this entity

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

getDownstreamVertex, getIdClass, getLengthKm, getOppositeDirectionSegment, getParent, getParentName, getUpstreamVertex, 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

Field Detail

CONNECTOID_SEGMENT_ID_CLASS

static final Class<ConnectoidSegment> CONNECTOID_SEGMENT_ID_CLASS

additional id class for generating connectoid segment ids

Method Detail

getConnectoidSegmentIdClass

default Class<ConnectoidSegment> getConnectoidSegmentIdClass()

Return class used to generate unique connectoid edge segment ids via the id generator

Returns:

class type

shallowClone

ConnectoidSegment 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

Returns:

shallow copy of entity

deepClone

ConnectoidSegment 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

Returns:

deep copy of entity

getConnectoidSegmentId

long getConnectoidSegmentId()

Collect the unqiue connectoid segment id

Returns:

connectoid segment id

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