ConnectoidSegment (planit-all 0.3.0 API)

All Superinterfaces:

Cloneable, 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.EdgeSegment
  EDGE_SEGMENT_ID_CLASS

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`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

Methods inherited from interface org.goplanit.utils.graph.EdgeSegment
clone, getDownstreamVertex, getIdClass, getParentEdge, getParentName, getUpstreamVertex, 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
  - 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
  - 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