Module org.arakhne.afc.gis.gisroad
Package org.arakhne.afc.gis.road

Class SubRoadNetwork.TerminalConnection

    • Constructor Detail

      • TerminalConnection

        TerminalConnection​(RoadConnection connection,
                   RoadSegment segment,
                   boolean connectedToStart)
        Constructor.
        Parameters:
        connection - the wrapped connection.
        segment - the segment.
        connectedToStart - indicates if the segment is connected to its start.

    • Method Detail

      • toClockwiseIterator

        @Pure
public final 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

        Specified by:
        toClockwiseIterator in interface RoadConnection
        Parameters:
        startSegment - is the first segment to iterate.
        endSegment - is the last segment to iterate.
        Returns:
        the iterator on segments.

      • toClockwiseIterator

        @Pure
public final 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 the default clockwhise type.

        This function assumes a CoordinateSystemConstants.GIS_2D

        Specified by:
        toClockwiseIterator in interface RoadConnection
        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 final 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

        Specified by:
        toClockwiseIterator in interface RoadConnection
        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 final 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

        Specified by:
        toClockwiseIterator in interface RoadConnection
        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 final 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

        Specified by:
        toClockwiseIterator in interface RoadConnection
        Parameters:
        startSegment - is the first segment to iterate.
        Returns:
        an iterable data structure.

      • toClockwiseIterator

        @Pure
public final 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

        Specified by:
        toClockwiseIterator in interface RoadConnection
        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 final 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.
        Specified by:
        toClockwiseIterator in interface RoadConnection
        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 final 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 the default clockwhise type.

        Specified by:
        toClockwiseIterator in interface RoadConnection
        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 final 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.
        Specified by:
        toClockwiseIterator in interface RoadConnection
        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 final 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.

        Specified by:
        toClockwiseIterator in interface RoadConnection
        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 final 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.

        Specified by:
        toClockwiseIterator in interface RoadConnection
        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 final 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.

        Specified by:
        toClockwiseIterator in interface RoadConnection
        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 final 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

        Specified by:
        toCounterclockwiseIterator in interface RoadConnection
        Parameters:
        startSegment - is the first segment to iterate.
        endSegment - is the last segment to iterate.
        Returns:
        the iterator on segments.

      • toCounterclockwiseIterator

        @Pure
public final 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 the default clockwhise type.

        This function assumes a CoordinateSystemConstants.GIS_2D

        Specified by:
        toCounterclockwiseIterator in interface RoadConnection
        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 final 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

        Specified by:
        toCounterclockwiseIterator in interface RoadConnection
        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 final 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

        Specified by:
        toCounterclockwiseIterator in interface RoadConnection
        Parameters:
        startSegment - is the first segment to iterate.
        Returns:
        an iterable data structure.

      • toCounterclockwiseIterator

        @Pure
public final 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

        Specified by:
        toCounterclockwiseIterator in interface RoadConnection
        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 final 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.
        Specified by:
        toCounterclockwiseIterator in interface RoadConnection
        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 final 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 the default clockwhise type.

        Specified by:
        toCounterclockwiseIterator in interface RoadConnection
        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 final 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.
        Specified by:
        toCounterclockwiseIterator in interface RoadConnection
        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 final 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.

        Specified by:
        toCounterclockwiseIterator in interface RoadConnection
        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 final 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.

        Specified by:
        toCounterclockwiseIterator in interface RoadConnection
        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 final 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.

        Specified by:
        toCounterclockwiseIterator in interface RoadConnection
        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.