UndirectedConnectoid (PLANitAllJavaOnly 0.4.0 API)

All Superinterfaces:

Comparable<IdAble>, Connectoid, ExternalIdAble, IdAble, Iterable<Zone>, ManagedId

All Known Implementing Classes:

UndirectedConnectoidImpl
```
public interface UndirectedConnectoid
extends Connectoid
```
An undirected connectoid is accessed through a referenced node where all incoming/outgoing edges/edge segments potentially have access. Hence it is undirected

Author:

markr

Field Summary

Fields
Modifier and Type Field Description

static Class<UndirectedConnectoid> UNDIRECTED_CONNECTOID_ID_CLASS
the class to use for the additional directed connectoid id generation
- Fields inherited from interface org.goplanit.utils.zoning.Connectoid
  CONNECTOID_ID_CLASS, DEFAULT_CONNECTOID_TYPE, DEFAULT_LENGTH_KM

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`UndirectedConnectoid`	`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.
`long`	`getUndirectedConnectoidId()`	collect the undirected connectoid id
`default Class<UndirectedConnectoid>`	`getUndirectedConnectoidIdClass()`	the class for undirected connectoid id generation
`UndirectedConnectoid`	`shallowClone()`	Create a shallow copy of this entity

Methods inherited from interface org.goplanit.utils.zoning.Connectoid
addAccessZone, addAllAccessZones, addAllowedMode, addAllowedModes, addAllowedModes, getAccessVertex, getAccessZones, getExplicitlyAllowedModes, getFirstAccessZone, getIdClass, getLengthKm, getName, getNumberOfAccessZones, getType, hasAccessZone, hasAccessZones, hasExplicitlyAllowedModes, hasLength, hasName, isAllModesAllowed, isModeAllowed, setLength, setName, setType

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 java.lang.Iterable
forEach, iterator, spliterator

Methods inherited from interface org.goplanit.utils.id.ManagedId
recreateManagedIds, resetChildManagedIdEntities

- Field Detail
  - UNDIRECTED_CONNECTOID_ID_CLASS
```
static final Class<UndirectedConnectoid> UNDIRECTED_CONNECTOID_ID_CLASS
```
    the class to use for the additional directed connectoid id generation
- Method Detail
  - getUndirectedConnectoidId
```
long getUndirectedConnectoidId()
```
    collect the undirected connectoid id
    
    Returns:
    
    undirected connectoid id
  - getUndirectedConnectoidIdClass
```
default Class<UndirectedConnectoid> getUndirectedConnectoidIdClass()
```
    the class for undirected connectoid id generation
    
    Returns:
    
    class to use
  - shallowClone
```
UndirectedConnectoid shallowClone()
```
    Create a shallow copy of this entity
    
    Specified by:
    
    shallowClone in interface Connectoid
    
    Specified by:
    
    shallowClone in interface IdAble
    
    Returns:
    
    shallow copy of entity
  - deepClone
```
UndirectedConnectoid 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 Connectoid
    
    Specified by:
    
    deepClone in interface IdAble
    
    Returns:
    
    deep copy of entity