Package org.goplanit.utils.network.virtual

Interface ConjugateConnectoidEdge

All Superinterfaces:

Comparable<IdAble>, ConjugateDirectedEdge, DirectedEdge, Edge, ExternalIdAble, GraphEntity, IdAble, ManagedId, Serializable

All Known Implementing Classes:

ConjugateConnectoidEdgeImpl

public interface ConjugateConnectoidEdge
extends ConjugateDirectedEdge

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<ConjugateConnectoidEdge>	CONJUGATE_CONNECTOID_EDGE_ID_CLASS	additional id class for generating conjugate connectoid edge ids

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

EDGE_ID_CLASS

Method Summary

Modifier and Type	Method	Description
ConjugateConnectoidEdge	deepClone()	Deep copy, non-owned members are reference copied
default Class<ConjugateConnectoidEdge>	getConnectoidEdgeIdClass()	Return class used to generate unique conjugate connectoid edge ids via the id generator
default ConjugateConnectoidSegment	getEdgeSegment(boolean directionAb)	Edge segment in the direction indicated
ConjugateConnectoidSegment	getEdgeSegmentAb()	Edge segment in the direction from A to B
ConjugateConnectoidSegment	getEdgeSegmentBa()	Edge segment in the direction from B to A
default Collection<? extends ConjugateConnectoidSegment>	getEdgeSegments()	collect all edge segments available on the edge
ConjugateConnectoidNode	getVertexA()	Vertex A of the edge
ConjugateConnectoidNode	getVertexB()	Vertex B of the edge
ConjugateConnectoidSegment	registerEdgeSegment(EdgeSegment edgeSegment, boolean directionAB, boolean force)	Register EdgeSegment.
ConjugateConnectoidSegment	removeEdgeSegmentAb()	Remove edge segmentAb from this edge.
ConjugateConnectoidSegment	removeEdgeSegmentBa()	Remove edge segmentAb from this edge.
ConjugateConnectoidEdge	shallowClone()	Shallow copy

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

getOriginalAdjacentEdges, getOriginalAdjacentEdgeSegments

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

forEachSegment, hasEdgeSegment, hasEdgeSegmentAb, hasEdgeSegmentBa, registerEdgeSegment, removeEdgeSegment, 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

CONJUGATE_CONNECTOID_EDGE_ID_CLASS

static final Class<ConjugateConnectoidEdge> CONJUGATE_CONNECTOID_EDGE_ID_CLASS

additional id class for generating conjugate connectoid edge ids

Method Detail

shallowClone

ConjugateConnectoidEdge shallowClone()

Shallow copy

Specified by:

shallowClone in interface ConjugateDirectedEdge

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

ConjugateConnectoidEdge deepClone()

Deep copy, non-owned members are reference copied

Specified by:

deepClone in interface ConjugateDirectedEdge

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

getConnectoidEdgeIdClass

default Class<ConjugateConnectoidEdge> getConnectoidEdgeIdClass()

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

Returns:

class type

getVertexA

ConjugateConnectoidNode getVertexA()

Vertex A of the edge

Specified by:

getVertexA in interface ConjugateDirectedEdge

Specified by:

getVertexA in interface DirectedEdge

Specified by:

getVertexA in interface Edge

Returns:

vertex A

getVertexB

ConjugateConnectoidNode getVertexB()

Vertex B of the edge

Specified by:

getVertexB in interface ConjugateDirectedEdge

Specified by:

getVertexB in interface DirectedEdge

Specified by:

getVertexB in interface Edge

Returns:

vertex B

registerEdgeSegment

ConjugateConnectoidSegment registerEdgeSegment(EdgeSegment edgeSegment,
                                               boolean directionAB,
                                               boolean force)

Register EdgeSegment. If there already exists an edgeSegment for that direction it is replaced and returned. If the edge segment has no parent edge, this edge is set. If there is a discrepancy between the edge segment's parent edge and this edge a warning is issued and the edge segment is not registered

Specified by:

registerEdgeSegment in interface ConjugateDirectedEdge

Specified by:

registerEdgeSegment in interface DirectedEdge

Parameters:

edgeSegment - the edgeSegment to be registered

directionAB - direction of travel

force - when true the provided edge segment is always set (even if null or inconsistent, without warning)

Returns:

replaced egeSegment (if any)

removeEdgeSegmentAb

ConjugateConnectoidSegment removeEdgeSegmentAb()

Remove edge segmentAb from this edge. Be careful doing this as it because it might affect the contiguous ids if the edge segment is garbage collected

Specified by:

removeEdgeSegmentAb in interface ConjugateDirectedEdge

Specified by:

removeEdgeSegmentAb in interface DirectedEdge

Returns:

removed edge segment

removeEdgeSegmentBa

ConjugateConnectoidSegment removeEdgeSegmentBa()

Remove edge segmentAb from this edge. Be careful doing this as it because it might affect the contiguous ids if the edge segment is garbage collected

Specified by:

removeEdgeSegmentBa in interface ConjugateDirectedEdge

Specified by:

removeEdgeSegmentBa in interface DirectedEdge

Returns:

removed edge segment

getEdgeSegmentAb

ConjugateConnectoidSegment getEdgeSegmentAb()

Edge segment in the direction from A to B

Specified by:

getEdgeSegmentAb in interface ConjugateDirectedEdge

Specified by:

getEdgeSegmentAb in interface DirectedEdge

Returns:

edge segment AB

getEdgeSegmentBa

ConjugateConnectoidSegment getEdgeSegmentBa()

Edge segment in the direction from B to A

Specified by:

getEdgeSegmentBa in interface ConjugateDirectedEdge

Specified by:

getEdgeSegmentBa in interface DirectedEdge

Returns:

edge segment BA

getEdgeSegment

default ConjugateConnectoidSegment getEdgeSegment(boolean directionAb)

Edge segment in the direction indicated

Specified by:

getEdgeSegment in interface ConjugateDirectedEdge

Specified by:

getEdgeSegment in interface DirectedEdge

Parameters:

directionAb - direction of segment

Returns:

edge segment if present

getEdgeSegments

default Collection<? extends ConjugateConnectoidSegment> getEdgeSegments()

collect all edge segments available on the edge

Specified by:

getEdgeSegments in interface ConjugateDirectedEdge

Specified by:

getEdgeSegments in interface DirectedEdge

Returns:

available edge segments