Connectoid (PLANitAllJava 0.1.0 API)

All Superinterfaces:

Comparable<Edge>, Edge, Serializable

All Known Implementing Classes:

ConnectoidImpl
```
public interface Connectoid
extends Edge
```
the connecting component between centroid and a first physical node in the network. Note that all connectoids are edges but not all edges are connectoids

Author:

markr

Field Summary

Fields
Modifier and Type Field Description

static double DEFAULT_LENGTH_KM
Default connectoid length in km

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`long`	`getConnectoidId()`	Return the unique id of this connectoid
`Object`	`getExternalId()`	Collect the external id of this connectoid
`boolean`	`hasExternalId()`	Returns true if this connectoid has its external Id set, false otherwise
`ConnectoidSegment`	`registerConnectoidSegment(ConnectoidSegment connectoidSegment, boolean directionAB)`	Register connectoidSegment.
`void`	`setExternalId(Object externalId)`	set the external id of this connectoid

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface org.planit.utils.graph.Edge
addInputProperty, getEdgeSegmentAB, getEdgeSegmentBA, getId, getInputProperty, getLength, getName, getVertexA, getVertexB

- Field Detail
  - DEFAULT_LENGTH_KM
```
static final double DEFAULT_LENGTH_KM
```
    Default connectoid length in km
    
    See Also:
    
    Constant Field Values
- Method Detail
  - 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
  - getConnectoidId
```
long getConnectoidId()
```
    Return the unique id of this connectoid
    
    Returns:
    
    id of this connectoid
  - getExternalId
```
Object getExternalId()
```
    Collect the external id of this connectoid
    
    Returns:
    
    external id
  - setExternalId
```
void setExternalId(Object externalId)
```
    set the external id of this connectoid
    
    Parameters:
    
    externalId - the external id to set
  - hasExternalId
```
boolean hasExternalId()
```
    Returns true if this connectoid has its external Id set, false otherwise
    
    Returns:
    
    true if this connectoid has its external Id set, false otherwise