DirectedConnectoid (PLANitAllJava 0.2.0 API)

All Superinterfaces:

Comparable<Idable>, Connectoid, ExternalIdable, Idable, Iterable<Zone>

All Known Implementing Classes:

DirectedConnectoidImpl
```
public interface DirectedConnectoid
extends Connectoid
```
A directed connectoid is referring to an edge segment in a network (layer) which is directed for access hence, the connectoid also being directed TODO: we can potentially get rid of UndirectedConnectoid and let DirectedConnectoid extend from base since they now both rely on accessNodes

Author:

markr

Field Summary

Fields
Modifier and Type Field Description

static boolean DEFAULT_NODE_ACCESS_DOWNSTREAM
default node access is set to the downstream end of a link segment
- Fields inherited from interface org.planit.utils.zoning.Connectoid
  DEFAULT_CONNECTOID_TYPE, DEFAULT_LENGTH_KM

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`LinkSegment`	`getAccessLinkSegment()`	the edge segment that provides access
`default Node`	`getAccessNode()`	Based on the edge segment and the location (upstream/downstream) of the access point, collect the access node
`boolean`	`isNodeAccessDownstream()`	determine if the node access is downstream or not
`void`	`setNodeAccessDownstream(boolean nodeAccessDownstream)`	set if the node access is downstream or not

Methods inherited from interface org.planit.utils.zoning.Connectoid
addAccessZone, addAllowedMode, getAccessZones, getFirstAccessZone, getLength, getName, getNumberOfAccessZones, getType, hasAccessZone, isModeAllowed, setLength, setName, setType

Methods inherited from interface org.planit.utils.id.ExternalIdable
getExternalId, getXmlId, hasExternalId, hasXmlId, setExternalId, setXmlId

Methods inherited from interface org.planit.utils.id.Idable
compareTo, getId, idEquals, idHashCode

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Field Detail
  - DEFAULT_NODE_ACCESS_DOWNSTREAM
```
static final boolean DEFAULT_NODE_ACCESS_DOWNSTREAM
```
    default node access is set to the downstream end of a link segment
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getAccessLinkSegment
```
LinkSegment getAccessLinkSegment()
```
    the edge segment that provides access
    
    Returns:
    
    access edge segment
  - setNodeAccessDownstream
```
void setNodeAccessDownstream(boolean nodeAccessDownstream)
```
    set if the node access is downstream or not
    
    Parameters:
    
    nodeAccessDownstream - true to set it downstream, false otherwise
  - isNodeAccessDownstream
```
boolean isNodeAccessDownstream()
```
    determine if the node access is downstream or not
    
    Returns:
    
    true when downstream, false otherwise, i.e., upstream
  - getAccessNode
```
default Node getAccessNode()
```
    Based on the edge segment and the location (upstream/downstream) of the access point, collect the access node
    
    Returns:
    
    accessNode to use