Class ExclusionRoadConnection
- java.lang.Object
-
- org.arakhne.afc.gis.road.primitive.AbstractWrapRoadConnection
-
- org.arakhne.afc.gis.road.primitive.ExclusionRoadConnection
-
- All Implemented Interfaces:
Comparable<GraphPoint<RoadConnection,RoadSegment>>
,RoadConnection
,GraphPoint<RoadConnection,RoadSegment>
public class ExclusionRoadConnection extends AbstractWrapRoadConnection
This class provides the implementation of a road connection wrapped to an other road connection and that is excluding several road segments of the wrapped connection.- Since:
- 14.0
- Version:
- 17.0 2020-01-04 14:41:55
- Author:
- Stéphane GALLAND
- Maven Group Id:
- org.arakhne.afc.gis
- Maven Artifact Id:
- gisroad
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.arakhne.afc.math.graph.GraphPoint
GraphPoint.GraphPointConnection<PT extends GraphPoint<PT,ST>,ST extends GraphSegment<ST,PT>>
-
Nested classes/interfaces inherited from interface org.arakhne.afc.gis.road.primitive.RoadConnection
RoadConnection.ClockwiseBoundType
-
-
Field Summary
-
Fields inherited from class org.arakhne.afc.gis.road.primitive.AbstractWrapRoadConnection
connection
-
Fields inherited from interface org.arakhne.afc.gis.road.primitive.RoadConnection
DEFAULT_CLOCKWHISE_TYPE
-
-
Constructor Summary
Constructors Constructor Description ExclusionRoadConnection(RoadConnection con, RoadSegment... excludedSegments)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RoadSegment
getConnectedSegment(int index)
Replies the connected segment at the specified index.int
getConnectedSegmentCount()
Replies the count of segments connected to this point.Iterable<RoadSegment>
getConnectedSegments()
Replies the list of segments connected to this point.Iterable<RoadSegment>
getConnectedSegmentsStartingFrom(RoadSegment startingSegment)
Replies the list of segments connected to this point.Iterable<RoadSegment>
getConnectedSegmentsStartingFromInReverseOrder(RoadSegment startingSegment)
Replies the list of segments connected to this point in reverse order.Iterable<? extends GraphPoint.GraphPointConnection<RoadConnection,RoadSegment>>
getConnections()
Replies the list of segment connections for this point.Iterable<? extends GraphPoint.GraphPointConnection<RoadConnection,RoadSegment>>
getConnectionsStartingFrom(RoadSegment startingPoint)
Replies the list of segment connections for this point.Iterable<? extends GraphPoint.GraphPointConnection<RoadConnection,RoadSegment>>
getConnectionsStartingFromInReverseOrder(RoadSegment startingPoint)
Replies the list of segment connections for this point in reverse order.RoadSegment
getOtherSideSegment(RoadSegment refSegment)
Replies the other segment also connected to this point.boolean
isConnectedSegment(RoadSegment segment)
Replies if the specified segment was connected to this point.boolean
isExcludedRoadSegment(RoadSegment segment)
Replies if the given road segment is excluded.Iterator<RoadSegment>
toClockwiseIterator(RoadSegment startSegment)
Replies an iterator which loop on the segment in a clockwise order from the specified segment.Iterator<RoadSegment>
toClockwiseIterator(RoadSegment startSegment, Boolean startSegmentConnectedByItsStart, RoadSegment endSegment, Boolean endSegmentConnectedByItsStart)
Replies an iterator which loop on the segment in a clockwise order from the specified start segment to the specified end segment.Iterator<RoadSegment>
toClockwiseIterator(RoadSegment startSegment, Boolean startSegmentConnectedByItsStart, RoadSegment endSegment, Boolean endSegmentConnectedByItsStart, RoadConnection.ClockwiseBoundType boundType)
Replies an iterator which loop on the segment in a clockwise order from the specified start segment to the specified end segment.Iterator<RoadSegment>
toClockwiseIterator(RoadSegment startSegment, Boolean startSegmentConnectedByItsStart, RoadSegment endSegment, Boolean endSegmentConnectedByItsStart, RoadConnection.ClockwiseBoundType boundType, CoordinateSystem2D system)
Replies an iterator which loop on the segment in a clockwise order from the specified start segment to the specified end segment.Iterator<RoadSegment>
toClockwiseIterator(RoadSegment startSegment, Boolean startSegmentConnectedByItsStart, RoadSegment endSegment, Boolean endSegmentConnectedByItsStart, CoordinateSystem2D system)
Replies an iterator which loop on the segment in a clockwise order from the specified start segment to the specified end segment.Iterator<RoadSegment>
toClockwiseIterator(RoadSegment startSegment, RoadConnection.ClockwiseBoundType boundType)
Replies an iterator which loop on the segment in a clockwise order from the specified segment.Iterator<RoadSegment>
toClockwiseIterator(RoadSegment startSegment, RoadConnection.ClockwiseBoundType boundType, CoordinateSystem2D system)
Replies an iterator which loop on the segment in a clockwise order from the specified segment.Iterator<RoadSegment>
toClockwiseIterator(RoadSegment startSegment, RoadSegment endSegment)
Replies an iterator which loop on the segment in a clockwise order from the first occurrence. of specified start segment to the first occurrence. of the specified end segment.Iterator<RoadSegment>
toClockwiseIterator(RoadSegment startSegment, RoadSegment endSegment, RoadConnection.ClockwiseBoundType boundType)
Replies an iterator which loop on the segment in a clockwise order from the first occurrence. of specified start segment to the first occurrence. of the specified end segment.Iterator<RoadSegment>
toClockwiseIterator(RoadSegment startSegment, RoadSegment endSegment, RoadConnection.ClockwiseBoundType boundType, CoordinateSystem2D system)
Replies an iterator which loop on the segment in a clockwise order from the first occurrence. of specified start segment to the first occurrence. of the specified end segment.Iterator<RoadSegment>
toClockwiseIterator(RoadSegment startSegment, RoadSegment endSegment, CoordinateSystem2D system)
Replies an iterator which loop on the segment in a clockwise order from the first occurrence. of specified start segment to the first occurrence. of the specified end segment.Iterator<RoadSegment>
toClockwiseIterator(RoadSegment startSegment, CoordinateSystem2D system)
Replies an iterator which loop on the segment in a clockwise order from the specified segment.Iterator<RoadSegment>
toCounterclockwiseIterator(RoadSegment startSegment)
Replies an iterator which loop on the segment in a counterclockwise order from the specified segment.Iterator<RoadSegment>
toCounterclockwiseIterator(RoadSegment startSegment, Boolean startSegmentConnectedByItsStart, RoadSegment endSegment, Boolean endSegmentConnectedByItsStart)
Replies an iterator which loop on the segment in a counterclockwise order from the specified start segment to the specified end segment.Iterator<RoadSegment>
toCounterclockwiseIterator(RoadSegment startSegment, Boolean startSegmentConnectedByItsStart, RoadSegment endSegment, Boolean endSegmentConnectedByItsStart, RoadConnection.ClockwiseBoundType boundType)
Replies an iterator which loop on the segment in a counterclockwise order from the specified start segment to the specified end segment.Iterator<RoadSegment>
toCounterclockwiseIterator(RoadSegment startSegment, Boolean startSegmentConnectedByItsStart, RoadSegment endSegment, Boolean endSegmentConnectedByItsStart, RoadConnection.ClockwiseBoundType boundType, CoordinateSystem2D system)
Replies an iterator which loop on the segment in a counterclockwise order from the specified start segment to the specified end segment.Iterator<RoadSegment>
toCounterclockwiseIterator(RoadSegment startSegment, Boolean startSegmentConnectedByItsStart, RoadSegment endSegment, Boolean endSegmentConnectedByItsStart, CoordinateSystem2D system)
Replies an iterator which loop on the segment in a counterclockwise order from the specified start segment to the specified end segment.Iterator<RoadSegment>
toCounterclockwiseIterator(RoadSegment startSegment, RoadConnection.ClockwiseBoundType boundType)
Replies an iterator which loop on the segment in a counterclockwise order from the specified segment.Iterator<RoadSegment>
toCounterclockwiseIterator(RoadSegment startSegment, RoadConnection.ClockwiseBoundType boundType, CoordinateSystem2D system)
Replies an iterator which loop on the segment in a counterclockwise order from the specified segment.Iterator<RoadSegment>
toCounterclockwiseIterator(RoadSegment startSegment, RoadSegment endSegment)
Replies an iterator which loop on the segment in a counterclockwise order from the first occurrence. of specified start segment to the first occurrence. of the specified end segment.Iterator<RoadSegment>
toCounterclockwiseIterator(RoadSegment startSegment, RoadSegment endSegment, RoadConnection.ClockwiseBoundType boundType)
Replies an iterator which loop on the segment in a counterclockwise order from the first occurrence. of specified start segment to the first occurrence. of the specified end segment.Iterator<RoadSegment>
toCounterclockwiseIterator(RoadSegment startSegment, RoadSegment endSegment, RoadConnection.ClockwiseBoundType boundType, CoordinateSystem2D system)
Replies an iterator which loop on the segment in a counterclockwise order from the first occurrence. of specified start segment to the first occurrence. of the specified end segment.Iterator<RoadSegment>
toCounterclockwiseIterator(RoadSegment startSegment, RoadSegment endSegment, CoordinateSystem2D system)
Replies an iterator which loop on the segment in a counterclockwise order from the first occurrence. of specified start segment to the first occurrence. of the specified end segment.Iterator<RoadSegment>
toCounterclockwiseIterator(RoadSegment startSegment, CoordinateSystem2D system)
Replies an iterator which loop on the segment in a counterclockwise order from the specified segment.-
Methods inherited from class org.arakhne.afc.gis.road.primitive.AbstractWrapRoadConnection
compareTo, compareTo, equals, getGeoLocation, getPoint, getUUID, getWrappedRoadConnection, hashCode, isEmpty, isFinalConnectionPoint, isNearPoint, isReallyCulDeSac, toString
-
-
-
-
Constructor Detail
-
ExclusionRoadConnection
public ExclusionRoadConnection(RoadConnection con, RoadSegment... excludedSegments)
Constructor.- Parameters:
con
- is the wrapped connection.excludedSegments
- are the segments excluded from the collection of the connected segments.
-
-
Method Detail
-
isExcludedRoadSegment
@Pure public boolean isExcludedRoadSegment(RoadSegment segment)
Replies if the given road segment is excluded.- Parameters:
segment
- a segment.- Returns:
true
if the road segment is excluded; otherwisefalse
.
-
getConnectedSegment
@Pure public RoadSegment getConnectedSegment(int index) throws ArrayIndexOutOfBoundsException
Description copied from interface:RoadConnection
Replies the connected segment at the specified index.- Parameters:
index
- is the index of the segment to remove.- Returns:
- the connected segment at the given index
- Throws:
ArrayIndexOutOfBoundsException
- in case of error.
-
getConnectedSegmentCount
@Pure public int getConnectedSegmentCount()
Description copied from interface:GraphPoint
Replies the count of segments connected to this point.- Returns:
- the count of segments connected to this point.
-
getConnectedSegments
@Pure public Iterable<RoadSegment> getConnectedSegments()
Description copied from interface:GraphPoint
Replies the list of segments connected to this point.- Returns:
- the list of segments connected to this point.
-
getConnectedSegmentsStartingFrom
@Pure public Iterable<RoadSegment> getConnectedSegmentsStartingFrom(RoadSegment startingSegment)
Description copied from interface:GraphPoint
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
GraphPoint.getConnectedSegments()
.- Parameters:
startingSegment
- the startint point.- Returns:
- the list of segments connected to this point.
-
getConnectedSegmentsStartingFromInReverseOrder
public Iterable<RoadSegment> getConnectedSegmentsStartingFromInReverseOrder(RoadSegment startingSegment)
Description copied from interface:GraphPoint
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
GraphPoint.getConnectedSegments()
in reverse order.- Parameters:
startingSegment
- the startint segment.- Returns:
- the list of segments connected to this point.
-
getConnections
@Pure public Iterable<? extends GraphPoint.GraphPointConnection<RoadConnection,RoadSegment>> getConnections()
Description copied from interface:GraphPoint
Replies the list of segment connections for this point.- Returns:
- the list of segments connected to this point.
-
getConnectionsStartingFrom
@Pure public Iterable<? extends GraphPoint.GraphPointConnection<RoadConnection,RoadSegment>> getConnectionsStartingFrom(RoadSegment startingPoint)
Description copied from interface:GraphPoint
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
GraphPoint.getConnections()
.- Parameters:
startingPoint
- the starting point.- Returns:
- the list of segments connected to this point.
-
getConnectionsStartingFromInReverseOrder
@Pure public Iterable<? extends GraphPoint.GraphPointConnection<RoadConnection,RoadSegment>> getConnectionsStartingFromInReverseOrder(RoadSegment startingPoint)
Description copied from interface:GraphPoint
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
GraphPoint.getConnections()
.- Parameters:
startingPoint
- the starting point.- Returns:
- the list of segments connected to this point.
-
getOtherSideSegment
@Pure public RoadSegment getOtherSideSegment(RoadSegment refSegment)
Description copied from interface:RoadConnection
Replies the other segment also connected to this point. If more than 2 segments were connected to this point, this function repliesnull
.- Parameters:
refSegment
- the segment.- Returns:
- the first segment if ref_segment was the second one.
the second segment if ref_segment was the first one.
otherwise
null
.
-
isConnectedSegment
@Pure public boolean isConnectedSegment(RoadSegment segment)
Description copied from interface:GraphPoint
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
-
toClockwiseIterator
@Pure public Iterator<RoadSegment> toClockwiseIterator(RoadSegment startSegment, RoadSegment endSegment)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a clockwise order from the first occurrence. of specified start segment to the first occurrence. of the specified end segment.This function assumes a
CoordinateSystemConstants.GIS_2D
- Parameters:
startSegment
- is the first segment to iterate.endSegment
- is the last segment to iterate.- Returns:
- the iterator on segments.
-
toClockwiseIterator
@Pure public Iterator<RoadSegment> toClockwiseIterator(RoadSegment startSegment, Boolean startSegmentConnectedByItsStart, RoadSegment endSegment, Boolean endSegmentConnectedByItsStart)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a clockwise order from the specified start segment to the specified end segment.This function assumes that startSegmentConnectedByItsStart and endSegmentConnectedByItsStart parameters indicates how the segments should be connected. These values are useful to indicates how to iterate when the segment is connected to this RoadConnexion by its two ends. The semantics of the these values are:
true
, the segment will be replied by the iterator when its start point will be found in the list;false
, the segment will be replied by the iterator when its end point will be found in the list;null
, the segment will be replied when it will be found at the first time in the list.
The first segment replied by this function will be the startSegment or the second segment from the list, according to the
default clockwhise type
. The last segment replied by this function will be the endSegment or the antepenulvian segment from the list, according to thedefault clockwhise type
.This function assumes a
CoordinateSystemConstants.GIS_2D
- Parameters:
startSegment
- is the first segment to iterate (inclusive).startSegmentConnectedByItsStart
- indicates if the start segment is connected by its first point.endSegment
- is the last segment to iterate (inclusive).endSegmentConnectedByItsStart
- indicates if the start segment is connected by its first point.- Returns:
- the iterator on segments.
-
toClockwiseIterator
@Pure public Iterator<RoadSegment> toClockwiseIterator(RoadSegment startSegment, RoadSegment endSegment, RoadConnection.ClockwiseBoundType boundType)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a clockwise order from the first occurrence. of specified start segment to the first occurrence. of the specified end segment.This function assumes a
CoordinateSystemConstants.GIS_2D
- Parameters:
startSegment
- is the first segment to iterate.endSegment
- is the last segment to iterate.boundType
- indicates if the two given segments will be included into the iterated segment set.- Returns:
- the iterator on segments.
-
toClockwiseIterator
@Pure public Iterator<RoadSegment> toClockwiseIterator(RoadSegment startSegment, Boolean startSegmentConnectedByItsStart, RoadSegment endSegment, Boolean endSegmentConnectedByItsStart, RoadConnection.ClockwiseBoundType boundType)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a clockwise order from the specified start segment to the specified end segment.This function assumes that startSegmentConnectedByItsStart and endSegmentConnectedByItsStart parameters indicates how the segments should be connected. These values are useful to indicates how to iterate when the segment is connected to this RoadConnexion by its two ends. The semantics of the these values are:
true
, the segment will be replied by the iterator when its start point will be found in the list;false
, the segment will be replied by the iterator when its end point will be found in the list;null
, the segment will be replied when it will be found at the first time in the list.
The first segment replied by this function will be the startSegment or the second segment from the list, according to bountType. The last segment replied by this function will be the endSegment or the antepenulvian segment from the list, according to bountType.
This function assumes a
CoordinateSystemConstants.GIS_2D
- Parameters:
startSegment
- is the first segment to iterate.startSegmentConnectedByItsStart
- indicates if the start segment is connected by its first point.endSegment
- is the last segment to iterate.endSegmentConnectedByItsStart
- indicates if the start segment is connected by its first point.boundType
- indicates if the two given segments will be included into the iterated segment set.- Returns:
- the iterator on segments.
-
toClockwiseIterator
@Pure public Iterator<RoadSegment> toClockwiseIterator(RoadSegment startSegment)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a clockwise order from the specified segment.The first segment replied by this function will be the startSegment or the second segment from the list, according to the
default clockwhise type
. Assuming that the segment candidates should be replied only once time if they are all included, the startSegment will never be replied as the last segment.This function assumes a
CoordinateSystemConstants.GIS_2D
- Parameters:
startSegment
- is the first segment to iterate.- Returns:
- an iterable data structure.
-
toClockwiseIterator
@Pure public Iterator<RoadSegment> toClockwiseIterator(RoadSegment startSegment, RoadConnection.ClockwiseBoundType boundType)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a clockwise order from the specified segment.The first segment replied by this function will be the startSegment or the second segment from the list, according to bountType. The last segment replied by this function will be the last or antepenulvian segment from the list, according to bountType.
This function assumes a
CoordinateSystemConstants.GIS_2D
- Parameters:
startSegment
- is the first segment to iterate.boundType
- indicates if the two given segments will be included into the iterated segment set.- Returns:
- an iterable data structure.
-
toClockwiseIterator
@Pure public Iterator<RoadSegment> toClockwiseIterator(RoadSegment startSegment, RoadSegment endSegment, CoordinateSystem2D system)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a clockwise order from the first occurrence. of specified start segment to the first occurrence. of the specified end segment.- Parameters:
startSegment
- is the first segment to iterate.endSegment
- is the last segment to iterate.system
- is the 2D coordinate system used to project a clockwise circle.- Returns:
- the iterator on segments.
-
toClockwiseIterator
@Pure public Iterator<RoadSegment> toClockwiseIterator(RoadSegment startSegment, Boolean startSegmentConnectedByItsStart, RoadSegment endSegment, Boolean endSegmentConnectedByItsStart, CoordinateSystem2D system)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a clockwise order from the specified start segment to the specified end segment.This function assumes that startSegmentConnectedByItsStart and endSegmentConnectedByItsStart parameters indicates how the segments should be connected. These values are useful to indicates how to iterate when the segment is connected to this RoadConnexion by its two ends. The semantics of the these values are:
true
, the segment will be replied by the iterator when its start point will be found in the list;false
, the segment will be replied by the iterator when its end point will be found in the list;null
, the segment will be replied when it will be found at the first time in the list.
The first segment replied by this function will be the startSegment or the second segment from the list, according to the
default clockwhise type
. The last segment replied by this function will be the endSegment or the antepenulvian segment from the list, according to thedefault clockwhise type
.- Parameters:
startSegment
- is the first segment to iterate (inclusive).startSegmentConnectedByItsStart
- indicates if the start segment is connected by its first point.endSegment
- is the last segment to iterate (inclusive).endSegmentConnectedByItsStart
- indicates if the start segment is connected by its first point.system
- is the 2D coordinate system used to project a clockwise circle.- Returns:
- the iterator on segments.
-
toClockwiseIterator
@Pure public Iterator<RoadSegment> toClockwiseIterator(RoadSegment startSegment, RoadSegment endSegment, RoadConnection.ClockwiseBoundType boundType, CoordinateSystem2D system)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a clockwise order from the first occurrence. of specified start segment to the first occurrence. of the specified end segment.- Parameters:
startSegment
- is the first segment to iterate.endSegment
- is the last segment to iterate.boundType
- indicates if the two given segments will be included into the iterated segment set.system
- is the 2D coordinate system used to project a clockwise circle.- Returns:
- the iterator on segments.
-
toClockwiseIterator
@Pure public Iterator<RoadSegment> toClockwiseIterator(RoadSegment startSegment, Boolean startSegmentConnectedByItsStart, RoadSegment endSegment, Boolean endSegmentConnectedByItsStart, RoadConnection.ClockwiseBoundType boundType, CoordinateSystem2D system)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a clockwise order from the specified start segment to the specified end segment.This function assumes that startSegmentConnectedByItsStart and endSegmentConnectedByItsStart parameters indicates how the segments should be connected. These values are useful to indicates how to iterate when the segment is connected to this RoadConnexion by its two ends. The semantics of the these values are:
true
, the segment will be replied by the iterator when its start point will be found in the list;false
, the segment will be replied by the iterator when its end point will be found in the list;null
, the segment will be replied when it will be found at the first time in the list.
The first segment replied by this function will be the startSegment or the second segment from the list, according to bountType. The last segment replied by this function will be the endSegment or the antepenulvian segment from the list, according to bountType.
- Parameters:
startSegment
- is the first segment to iterate.startSegmentConnectedByItsStart
- indicates if the start segment is connected by its first point.endSegment
- is the last segment to iterate.endSegmentConnectedByItsStart
- indicates if the start segment is connected by its first point.boundType
- indicates if the two given segments will be included into the iterated segment set.system
- is the 2D coordinate system used to project a clockwise circle.- Returns:
- the iterator on segments.
-
toClockwiseIterator
@Pure public Iterator<RoadSegment> toClockwiseIterator(RoadSegment startSegment, CoordinateSystem2D system)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a clockwise order from the specified segment.The first segment replied by this function will be the startSegment or the second segment from the list, according to the
default clockwhise type
. Assuming that the segment candidates should be replied only once time if they are all included, the startSegment will never be replied as the last segment.- Parameters:
startSegment
- is the first segment to iterate.system
- is the 2D coordinate system used to project a clockwise circle.- Returns:
- an iterable data structure.
-
toClockwiseIterator
@Pure public Iterator<RoadSegment> toClockwiseIterator(RoadSegment startSegment, RoadConnection.ClockwiseBoundType boundType, CoordinateSystem2D system)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a clockwise order from the specified segment.The first segment replied by this function will be the startSegment or the second segment from the list, according to bountType. The last segment replied by this function will be the last or antepenulvian segment from the list, according to bountType.
- Parameters:
startSegment
- is the first segment to iterate.boundType
- indicates if the two given segments will be included into the iterated segment set.system
- is the 2D coordinate system used to project a clockwise circle.- Returns:
- an iterable data structure.
-
toCounterclockwiseIterator
@Pure public Iterator<RoadSegment> toCounterclockwiseIterator(RoadSegment startSegment, RoadSegment endSegment)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a counterclockwise order from the first occurrence. of specified start segment to the first occurrence. of the specified end segment.This function assumes a
CoordinateSystemConstants.GIS_2D
- Parameters:
startSegment
- is the first segment to iterate.endSegment
- is the last segment to iterate.- Returns:
- the iterator on segments.
-
toCounterclockwiseIterator
@Pure public Iterator<RoadSegment> toCounterclockwiseIterator(RoadSegment startSegment, Boolean startSegmentConnectedByItsStart, RoadSegment endSegment, Boolean endSegmentConnectedByItsStart)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a counterclockwise order from the specified start segment to the specified end segment.This function assumes that startSegmentConnectedByItsStart and endSegmentConnectedByItsStart parameters indicates how the segments should be connected. These values are useful to indicates how to iterate when the segment is connected to this RoadConnexion by its two ends. The semantics of the these values are:
true
, the segment will be replied by the iterator when its start point will be found in the list;false
, the segment will be replied by the iterator when its end point will be found in the list;null
, the segment will be replied when it will be found at the first time in the list.
The first segment replied by this function will be the startSegment or the second segment from the list, according to the
default clockwhise type
. The last segment replied by this function will be the endSegment or the antepenulvian segment from the list, according to thedefault clockwhise type
.This function assumes a
CoordinateSystemConstants.GIS_2D
- Parameters:
startSegment
- is the first segment to iterate (inclusive).startSegmentConnectedByItsStart
- indicates if the start segment is connected by its first point.endSegment
- is the last segment to iterate (inclusive).endSegmentConnectedByItsStart
- indicates if the start segment is connected by its first point.- Returns:
- the iterator on segments.
-
toCounterclockwiseIterator
@Pure public Iterator<RoadSegment> toCounterclockwiseIterator(RoadSegment startSegment, RoadSegment endSegment, RoadConnection.ClockwiseBoundType boundType)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a counterclockwise order from the first occurrence. of specified start segment to the first occurrence. of the specified end segment.This function assumes a
CoordinateSystemConstants.GIS_2D
- Parameters:
startSegment
- is the first segment to iterate.endSegment
- is the last segment to iterate.boundType
- indicates if the two given segments will be included into the iterated segment set.- Returns:
- the iterator on segments.
-
toCounterclockwiseIterator
@Pure public Iterator<RoadSegment> toCounterclockwiseIterator(RoadSegment startSegment, Boolean startSegmentConnectedByItsStart, RoadSegment endSegment, Boolean endSegmentConnectedByItsStart, RoadConnection.ClockwiseBoundType boundType)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a counterclockwise order from the specified start segment to the specified end segment.This function assumes that startSegmentConnectedByItsStart and endSegmentConnectedByItsStart parameters indicates how the segments should be connected. These values are useful to indicates how to iterate when the segment is connected to this RoadConnexion by its two ends. The semantics of the these values are:
true
, the segment will be replied by the iterator when its start point will be found in the list;false
, the segment will be replied by the iterator when its end point will be found in the list;null
, the segment will be replied when it will be found at the first time in the list.
The first segment replied by this function will be the startSegment or the second segment from the list, according to bountType. The last segment replied by this function will be the endSegment or the antepenulvian segment from the list, according to bountType.
This function assumes a
CoordinateSystemConstants.GIS_2D
- Parameters:
startSegment
- is the first segment to iterate.startSegmentConnectedByItsStart
- indicates if the start segment is connected by its first point.endSegment
- is the last segment to iterate.endSegmentConnectedByItsStart
- indicates if the start segment is connected by its first point.boundType
- indicates if the two given segments will be included into the iterated segment set.- Returns:
- the iterator on segments.
-
toCounterclockwiseIterator
@Pure public Iterator<RoadSegment> toCounterclockwiseIterator(RoadSegment startSegment)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a counterclockwise order from the specified segment.The first segment replied by this function will be the startSegment or the second segment from the list, according to the
default clockwhise type
. Assuming that the segment candidates should be replied only once time if they are all included, the startSegment will never be replied as the last segment.This function assumes a
CoordinateSystemConstants.GIS_2D
- Parameters:
startSegment
- is the first segment to iterate.- Returns:
- an iterable data structure.
-
toCounterclockwiseIterator
@Pure public Iterator<RoadSegment> toCounterclockwiseIterator(RoadSegment startSegment, RoadConnection.ClockwiseBoundType boundType)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a counterclockwise order from the specified segment.The first segment replied by this function will be the startSegment or the second segment from the list, according to bountType. The last segment replied by this function will be the last or antepenulvian segment from the list, according to bountType.
This function assumes a
CoordinateSystemConstants.GIS_2D
- Parameters:
startSegment
- is the first segment to iterate.boundType
- indicates if the two given segments will be included into the iterated segment set.- Returns:
- an iterable data structure.
-
toCounterclockwiseIterator
@Pure public Iterator<RoadSegment> toCounterclockwiseIterator(RoadSegment startSegment, RoadSegment endSegment, CoordinateSystem2D system)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a counterclockwise order from the first occurrence. of specified start segment to the first occurrence. of the specified end segment.- Parameters:
startSegment
- is the first segment to iterate.endSegment
- is the last segment to iterate.system
- is the 2D coordinate system used to project a counterclockwise circle.- Returns:
- the iterator on segments.
-
toCounterclockwiseIterator
@Pure public Iterator<RoadSegment> toCounterclockwiseIterator(RoadSegment startSegment, Boolean startSegmentConnectedByItsStart, RoadSegment endSegment, Boolean endSegmentConnectedByItsStart, CoordinateSystem2D system)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a counterclockwise order from the specified start segment to the specified end segment.This function assumes that startSegmentConnectedByItsStart and endSegmentConnectedByItsStart parameters indicates how the segments should be connected. These values are useful to indicates how to iterate when the segment is connected to this RoadConnexion by its two ends. The semantics of the these values are:
true
, the segment will be replied by the iterator when its start point will be found in the list;false
, the segment will be replied by the iterator when its end point will be found in the list;null
, the segment will be replied when it will be found at the first time in the list.
The first segment replied by this function will be the startSegment or the second segment from the list, according to the
default clockwhise type
. The last segment replied by this function will be the endSegment or the antepenulvian segment from the list, according to thedefault clockwhise type
.- Parameters:
startSegment
- is the first segment to iterate (inclusive).startSegmentConnectedByItsStart
- indicates if the start segment is connected by its first point.endSegment
- is the last segment to iterate (inclusive).endSegmentConnectedByItsStart
- indicates if the start segment is connected by its first point.system
- is the 2D coordinate system used to project a counterclockwise circle.- Returns:
- the iterator on segments.
-
toCounterclockwiseIterator
@Pure public Iterator<RoadSegment> toCounterclockwiseIterator(RoadSegment startSegment, RoadSegment endSegment, RoadConnection.ClockwiseBoundType boundType, CoordinateSystem2D system)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a counterclockwise order from the first occurrence. of specified start segment to the first occurrence. of the specified end segment.- Parameters:
startSegment
- is the first segment to iterate.endSegment
- is the last segment to iterate.boundType
- indicates if the two given segments will be included into the iterated segment set.system
- is the 2D coordinate system used to project a counterclockwise circle.- Returns:
- the iterator on segments.
-
toCounterclockwiseIterator
@Pure public Iterator<RoadSegment> toCounterclockwiseIterator(RoadSegment startSegment, Boolean startSegmentConnectedByItsStart, RoadSegment endSegment, Boolean endSegmentConnectedByItsStart, RoadConnection.ClockwiseBoundType boundType, CoordinateSystem2D system)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a counterclockwise order from the specified start segment to the specified end segment.This function assumes that startSegmentConnectedByItsStart and endSegmentConnectedByItsStart parameters indicates how the segments should be connected. These values are useful to indicates how to iterate when the segment is connected to this RoadConnexion by its two ends. The semantics of the these values are:
true
, the segment will be replied by the iterator when its start point will be found in the list;false
, the segment will be replied by the iterator when its end point will be found in the list;null
, the segment will be replied when it will be found at the first time in the list.
The first segment replied by this function will be the startSegment or the second segment from the list, according to bountType. The last segment replied by this function will be the endSegment or the antepenulvian segment from the list, according to bountType.
- Parameters:
startSegment
- is the first segment to iterate.startSegmentConnectedByItsStart
- indicates if the start segment is connected by its first point.endSegment
- is the last segment to iterate.endSegmentConnectedByItsStart
- indicates if the start segment is connected by its first point.boundType
- indicates if the two given segments will be included into the iterated segment set.system
- is the 2D coordinate system used to project a counterclockwise circle.- Returns:
- the iterator on segments.
-
toCounterclockwiseIterator
@Pure public Iterator<RoadSegment> toCounterclockwiseIterator(RoadSegment startSegment, CoordinateSystem2D system)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a counterclockwise order from the specified segment.The first segment replied by this function will be the startSegment or the second segment from the list, according to the
default clockwhise type
. Assuming that the segment candidates should be replied only once time if they are all included, the startSegment will never be replied as the last segment.- Parameters:
startSegment
- is the first segment to iterate.system
- is the 2D coordinate system used to project a counterclockwise circle.- Returns:
- an iterable data structure.
-
toCounterclockwiseIterator
@Pure public Iterator<RoadSegment> toCounterclockwiseIterator(RoadSegment startSegment, RoadConnection.ClockwiseBoundType boundType, CoordinateSystem2D system)
Description copied from interface:RoadConnection
Replies an iterator which loop on the segment in a counterclockwise order from the specified segment.The first segment replied by this function will be the startSegment or the second segment from the list, according to bountType. The last segment replied by this function will be the last or antepenulvian segment from the list, according to bountType.
- Parameters:
startSegment
- is the first segment to iterate.boundType
- indicates if the two given segments will be included into the iterated segment set.system
- is the 2D coordinate system used to project a counterclockwise circle.- Returns:
- an iterable data structure.
-
-