Interface GraphPoint<PT extends GraphPoint<PT,ST>,ST extends GraphSegment<ST,PT>>
-
- Type Parameters:
PT
- is the type of node in the graphST
- is the type of edge in the graph
- All Superinterfaces:
Comparable<GraphPoint<PT,ST>>
- All Known Subinterfaces:
RoadConnection
- All Known Implementing Classes:
AbstractWrapRoadConnection
,ExclusionRoadConnection
,RoadAStar.VirtualPoint
,RoadConnectionWithArrivalSegment
,SGraphPoint
,StandardRoadConnection
,SubRoadNetwork.AbstractWrapConnection
,SubRoadNetwork.TerminalConnection
,SubRoadNetwork.WrapConnection
public interface GraphPoint<PT extends GraphPoint<PT,ST>,ST extends GraphSegment<ST,PT>> extends Comparable<GraphPoint<PT,ST>>
This interface representes a graph's point.- Since:
- 13.0
- Version:
- 17.0 2020-01-04 14:41:42
- Author:
- Stéphane GALLAND
- Maven Group Id:
- org.arakhne.afc.core
- Maven Artifact Id:
- mathgraph
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
GraphPoint.GraphPointConnection<PT extends GraphPoint<PT,ST>,ST extends GraphSegment<ST,PT>>
Describes a connection pair composed of the graph point and one graph segment.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getConnectedSegmentCount()
Replies the count of segments connected to this point.Iterable<ST>
getConnectedSegments()
Replies the list of segments connected to this point.Iterable<ST>
getConnectedSegmentsStartingFrom(ST startingPoint)
Replies the list of segments connected to this point.Iterable<ST>
getConnectedSegmentsStartingFromInReverseOrder(ST startingSegment)
Replies the list of segments connected to this point in reverse order.Iterable<? extends GraphPoint.GraphPointConnection<PT,ST>>
getConnections()
Replies the list of segment connections for this point.Iterable<? extends GraphPoint.GraphPointConnection<PT,ST>>
getConnectionsStartingFrom(ST startingPoint)
Replies the list of segment connections for this point.Iterable<? extends GraphPoint.GraphPointConnection<PT,ST>>
getConnectionsStartingFromInReverseOrder(ST startingPoint)
Replies the list of segment connections for this point in reverse order.boolean
isConnectedSegment(ST segment)
Replies if the specified segment was connected to this point.boolean
isFinalConnectionPoint()
Replies if this point is a final connection point ie, a point connected to only one segment.-
Methods inherited from interface java.lang.Comparable
compareTo
-
-
-
-
Method Detail
-
getConnectedSegmentCount
@Pure int getConnectedSegmentCount()
Replies the count of segments connected to this point.- Returns:
- the count of segments connected to this point.
-
getConnectedSegments
@Pure Iterable<ST> getConnectedSegments()
Replies the list of segments connected to this point.- Returns:
- the list of segments connected to this point.
-
getConnectedSegmentsStartingFrom
@Pure Iterable<ST> getConnectedSegmentsStartingFrom(ST startingPoint)
Replies the list of segments connected to this point.If the graph point implementation is supporting an ordered list of segment, it will reply the segments starting from the given segment. If the implementation does not support any order, it will reply the same as
getConnectedSegments()
.- Parameters:
startingPoint
- the startint point.- Returns:
- the list of segments connected to this point.
-
getConnectedSegmentsStartingFromInReverseOrder
@Pure Iterable<ST> getConnectedSegmentsStartingFromInReverseOrder(ST startingSegment)
Replies the list of segments connected to this point in reverse order.If the graph point implementation is supporting an ordered list of segment, it will reply the segments starting from the given segment. If the implementation does not support any order, it will reply the same as
getConnectedSegments()
in reverse order.- Parameters:
startingSegment
- the startint segment.- Returns:
- the list of segments connected to this point.
- Since:
- 16.0
-
getConnections
@Pure Iterable<? extends GraphPoint.GraphPointConnection<PT,ST>> getConnections()
Replies the list of segment connections for this point.- Returns:
- the list of segments connected to this point.
-
getConnectionsStartingFrom
@Pure Iterable<? extends GraphPoint.GraphPointConnection<PT,ST>> getConnectionsStartingFrom(ST startingPoint)
Replies the list of segment connections for this point.If the graph point implementation is supporting an ordered list of segment, it will reply the segments starting from the given segment. If the implementation does not support any order, it will reply the same as
getConnections()
.- Parameters:
startingPoint
- the starting point.- Returns:
- the list of segments connected to this point.
-
getConnectionsStartingFromInReverseOrder
@Pure Iterable<? extends GraphPoint.GraphPointConnection<PT,ST>> getConnectionsStartingFromInReverseOrder(ST startingPoint)
Replies the list of segment connections for this point in reverse order.If the graph point implementation is supporting an ordered list of segment, it will reply the segments starting from the given segment. If the implementation does not support any order, it will reply the same as
getConnections()
.- Parameters:
startingPoint
- the starting point.- Returns:
- the list of segments connected to this point.
- Since:
- 16.0
-
isConnectedSegment
@Pure boolean isConnectedSegment(ST segment)
Replies if the specified segment was connected to this point.- Parameters:
segment
- the starting point.- Returns:
true
if the given segment is connected to this node, otherwisefalse
-
isFinalConnectionPoint
@Pure boolean isFinalConnectionPoint()
Replies if this point is a final connection point ie, a point connected to only one segment.- Returns:
true
if zero or one segment was connected to this point, otherwhisefalse
-
-