Package org.goplanit.utils.zoning

Interface DirectedConnectoid

All Superinterfaces:

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

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
static Class<DirectedConnectoid>	DIRECTED_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

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
long	getDirectedConnectoidId()	Collect the directed connectoid id
default Class<DirectedConnectoid>	getDirectedConnectoidIdClass()	the class for directed connectoid id generation
default boolean	hasAccessLinkSegment()	Verify if an access link segment is present
boolean	isNodeAccessDownstream()	determine if the node access is downstream or not
void	replaceAccessLinkSegment(EdgeSegment exitEdgeSegment)	Replace the access link segment for this connectoid
void	setNodeAccessDownstream(boolean nodeAccessDownstream)	set if the node access is downstream or not

Methods inherited from interface org.goplanit.utils.zoning.Connectoid

addAccessZone, 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

getExternalId, getXmlId, hasExternalId, hasXmlId, setExternalId, setXmlId

Methods inherited from interface org.goplanit.utils.id.IdAble

clone, 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

DIRECTED_CONNECTOID_ID_CLASS

static final Class<DirectedConnectoid> DIRECTED_CONNECTOID_ID_CLASS

the class to use for the additional directed connectoid id generation

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

getDirectedConnectoidId

long getDirectedConnectoidId()

Collect the directed connectoid id

Returns:

directed connectoid id

getAccessLinkSegment

LinkSegment getAccessLinkSegment()

The edge segment that provides access

Returns:

access edge segment

replaceAccessLinkSegment

void replaceAccessLinkSegment(EdgeSegment exitEdgeSegment)

Replace the access link segment for this connectoid

Parameters:

exitEdgeSegment - to use

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

getDirectedConnectoidIdClass

default Class<DirectedConnectoid> getDirectedConnectoidIdClass()

the class for directed connectoid id generation

Returns:

class to use

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

hasAccessLinkSegment

default boolean hasAccessLinkSegment()

Verify if an access link segment is present

Returns:

true when present, false otherwise