Package org.goplanit.utils.network.virtual

Interface ConnectoidEdge

All Superinterfaces:

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

Modifier and Type	Method	Description
ConnectoidEdge	deepClone()	Deep copy, non-owned members are reference copied
default CentroidVertex	getCentroidVertex()	Collect the centroid vertex attached to the connectoid, which should always exist and only be a single one
long	getConnectoidEdgeId()	Return the unique id of this connectoid edge
default Class<ConnectoidEdge>	getConnectoidEdgeIdClass()	Return class used to generate unique connectoid edge ids via the id generator
default Vertex	getNonCentroidVertex()	Collect the non-centroid vertex attached to the connectoid, which should always exist and only be a single one
ConnectoidSegment	registerConnectoidSegment(ConnectoidSegment connectoidSegment, boolean directionAB)	Register connectoidSegment.
ConnectoidEdge	shallowClone()	Shallow copy

Methods inherited from interface org.goplanit.utils.graph.directed.DirectedEdge

forEachSegment, getEdgeSegment, getEdgeSegmentAb, getEdgeSegmentBa, getEdgeSegments, getVertexA, getVertexB, hasEdgeSegment, hasEdgeSegmentAb, hasEdgeSegmentBa, registerEdgeSegment, registerEdgeSegment, removeEdgeSegment, removeEdgeSegmentAb, removeEdgeSegmentBa, removeEdgeSegments, replace

Methods inherited from interface org.goplanit.utils.graph.Edge

addInputProperty, createEnvelope, getGeometry, getIdClass, getInputProperty, getLengthKm, getName, hasGeometry, hasName, hasVertex, hasVertexA, hasVertexB, hasVertices, isGeometryInAbDirection, isGeometryInAbDirection, isVertexA, populateBasicGeometry, removeVertex, replace, setGeometry, setLengthKm, setName, transformGeometry, updateGeometryInjectCoordinateAtProjectedLocation, validate

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

getConnectoidEdgeIdClass

default Class<ConnectoidEdge> getConnectoidEdgeIdClass()

Return class used to generate unique connectoid edge ids via the id generator

Returns:

class type

shallowClone

ConnectoidEdge shallowClone()

Shallow copy

Specified by:

shallowClone in interface DirectedEdge

Specified by:

shallowClone in interface Edge

Specified by:

shallowClone in interface GraphEntity

Specified by:

shallowClone in interface IdAble

Returns:

copy of this edge

deepClone

ConnectoidEdge deepClone()

Deep copy, non-owned members are reference copied

Specified by:

deepClone in interface DirectedEdge

Specified by:

deepClone in interface Edge

Specified by:

deepClone in interface GraphEntity

Specified by:

deepClone in interface IdAble

Returns:

copy of this edge

registerConnectoidSegment

ConnectoidSegment registerConnectoidSegment(ConnectoidSegment connectoidSegment,
                                            boolean directionAB)

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

getConnectoidEdgeId

long getConnectoidEdgeId()

Return the unique id of this connectoid edge

Returns:

id of this connectoid edge

getNonCentroidVertex

default Vertex getNonCentroidVertex()

Collect the non-centroid vertex attached to the connectoid, which should always exist and only be a single one

Returns:

non-centroid found, null if not found

getCentroidVertex

default CentroidVertex getCentroidVertex()

Collect the centroid vertex attached to the connectoid, which should always exist and only be a single one

Returns:

centroid found, null if not found