ConnectoidEdge (planit-all 0.3.0 API)

All Superinterfaces:

Cloneable, Comparable<IdAble>, DirectedEdge, Edge, ExternalIdAble, GraphEntity, IdAble, ManagedId, Serializable

All Known Implementing Classes:

ConnectoidEdgeImpl
```
public interface ConnectoidEdge
extends DirectedEdge
```
the connecting component between centroid and a first physical node in the network. Note that all connectoids are directed edges but not all edges are connectoids

Author:

markr

Field Summary

Fields
Modifier and Type Field Description

static Class<ConnectoidEdge> CONNECTOID_EDGE_ID_CLASS
additional id class for generating connectoid edge ids
- Fields inherited from interface org.goplanit.utils.graph.Edge
  EDGE_ID_CLASS

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`long`	`getConnectoidEdgeId()`	Return the unique id of this connectoid edge
`default Class<ConnectoidEdge>`	`getConnectoidSegmentIdClass()`	Return class used to generate unique connectoid edge ids via the id generator
`ConnectoidSegment`	`registerConnectoidSegment(ConnectoidSegment connectoidSegment, boolean directionAB)`	Register connectoidSegment.

Methods inherited from interface org.goplanit.utils.graph.directed.DirectedEdge
getEdgeSegment, getEdgeSegmentAb, getEdgeSegmentBa, getEdgeSegments, getVertexA, getVertexB, hasEdgeSegmentAb, hasEdgeSegmentBa, registerEdgeSegment, replace

Methods inherited from interface org.goplanit.utils.graph.Edge
addInputProperty, clone, createEnvelope, getGeometry, getIdClass, getInputProperty, getLengthKm, getName, hasGeometry, hasName, hasVertex, isGeometryInAbDirection, removeVertex, replace, setGeometry, setLengthKm, setName, transformGeometry, 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_EDGE_ID_CLASS
```
static final Class<ConnectoidEdge> CONNECTOID_EDGE_ID_CLASS
```
    additional id class for generating connectoid edge ids
- Method Detail
  - getConnectoidSegmentIdClass
```
default Class<ConnectoidEdge> getConnectoidSegmentIdClass()
```
    Return class used to generate unique connectoid edge ids via the id generator
    
    Returns:
    
    class type
  - registerConnectoidSegment
```
ConnectoidSegment registerConnectoidSegment(ConnectoidSegment connectoidSegment,
                                            boolean directionAB)
                                     throws PlanItException
```
    Register connectoidSegment. If there already exists a connectoidSegment for that direction it is replaced and returned
    
    Parameters:
    
    connectoidSegment - connectoid segment to be registered
    
    directionAB - direction of travel
    
    Returns:
    
    replaced ConnectoidSegment
    
    Throws:
    
    PlanItException - thrown if there is an error
  - getConnectoidEdgeId
```
long getConnectoidEdgeId()
```
    Return the unique id of this connectoid edge
    
    Returns:
    
    id of this connectoid edge