Package org.planit.utils.graph

Interface DirectedVertex

All Superinterfaces:

Comparable<Idable>, ExternalIdable, Idable, Serializable, Vertex

All Known Subinterfaces:

Centroid, Node

All Known Implementing Classes:

CentroidImpl, DirectedVertexImpl, NodeImpl

public interface DirectedVertex
extends Vertex

Directed vertex representation connected to one or more edge segments that have direction. The vertex itself is of course not directional

Author:

markr

Method Summary

Modifier and Type	Method	Description
boolean	addEdgeSegment(EdgeSegment edgeSegment)	Add edgeSegment, do not invoke when parsing networks, this connection is auto-populated before the assignment starts based on the edge segment vertices that have been registered.
default EdgeSegment	getEdgeSegment(DirectedVertex otherVertex)	collect the first edge segment corresponding to the provided other vertex
Set<EdgeSegment>	getEntryEdgeSegments()	Collect the entry edge segments of this vertex
Set<EdgeSegment>	getExitEdgeSegments()	Collect the exit edge segments of this vertex
int	getNumberOfEntryEdgeSegments()	Collect the number of entry edge segments of this vertex
int	getNumberOfExitEdgeSegments()	Collect the number of exit edge segments of this vertex
boolean	hasEntryEdgeSegments()	Test whether no entry edge segments have been registered
boolean	hasExitEdgeSegments()	Test whether no exit edge segments have been registered
boolean	removeEdgeSegment(EdgeSegment edgeSegment)	Remove edgeSegment
default boolean	replace(EdgeSegment edgeSegmentToReplace, EdgeSegment edgeSegmentToReplaceWith, boolean forceInsert)	replace edge segment

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 org.planit.utils.graph.Vertex

addEdge, addInputProperty, clone, getEdges, getEdges, getNumberOfEdges, getPosition, removeEdge, removeEdge, replace, setPosition, transformPosition, validate

Method Detail

hasExitEdgeSegments

boolean hasExitEdgeSegments()

Test whether no exit edge segments have been registered

Returns:

true if no exit edge segments have been registered, false otherwise

hasEntryEdgeSegments

boolean hasEntryEdgeSegments()

Test whether no entry edge segments have been registered

Returns:

true if no entry edge segments have been registered, false otherwise

addEdgeSegment

boolean addEdgeSegment(EdgeSegment edgeSegment)

Add edgeSegment, do not invoke when parsing networks, this connection is auto-populated before the assignment starts based on the edge segment vertices that have been registered.

Parameters:

edgeSegment - EdgeSegment object to be added

Returns:

true when added, false when already present (and not added)

removeEdgeSegment

boolean removeEdgeSegment(EdgeSegment edgeSegment)

Remove edgeSegment

Parameters:

edgeSegment - EdgeSegment object to be removed

Returns:

true when removed, false when not present (and not removed)

getEntryEdgeSegments

Set<EdgeSegment> getEntryEdgeSegments()

Collect the entry edge segments of this vertex

Returns:

edgeSegments

getExitEdgeSegments

Set<EdgeSegment> getExitEdgeSegments()

Collect the exit edge segments of this vertex

Returns:

edgeSegments

getNumberOfEntryEdgeSegments

int getNumberOfEntryEdgeSegments()

Collect the number of entry edge segments of this vertex

Returns:

number of entry edge segments

getNumberOfExitEdgeSegments

int getNumberOfExitEdgeSegments()

Collect the number of exit edge segments of this vertex

Returns:

number of exit edge segments

replace

default boolean replace(EdgeSegment edgeSegmentToReplace,
                        EdgeSegment edgeSegmentToReplaceWith,
                        boolean forceInsert)

replace edge segment

Parameters:

edgeSegmentToReplace - to replace

edgeSegmentToReplaceWith - to replace with

forceInsert - when edge segment to repoalce cannot be found, replacement is still inserted when true, when false not

Returns:

true when replacement/insert was successful

getEdgeSegment

default EdgeSegment getEdgeSegment(DirectedVertex otherVertex)

collect the first edge segment corresponding to the provided other vertex

Parameters:

otherVertex - to use

Returns:

first edge segment matching this signature