Module org.arakhne.afc.gis.gisroad
Enum RoadConnection.ClockwiseBoundType
- java.lang.Object
-
- java.lang.Enum<RoadConnection.ClockwiseBoundType>
-
- org.arakhne.afc.gis.road.primitive.RoadConnection.ClockwiseBoundType
-
- All Implemented Interfaces:
Serializable
,Comparable<RoadConnection.ClockwiseBoundType>
- Enclosing interface:
- RoadConnection
public static enum RoadConnection.ClockwiseBoundType extends Enum<RoadConnection.ClockwiseBoundType>
Describes the type of treatment for the bounds of a (counter)clockwise iterator on the segments.- 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
-
-
Enum Constant Summary
Enum Constants Enum Constant Description EXCLUDE_BOTH
The start and end segments are excluded from iterations.EXCLUDE_END_SEGMENT
The end segment is excluded from iterations.EXCLUDE_START_SEGMENT
The start segment is excluded from iterations.INCLUDE_BOTH
The start and end segments are included into iterations.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
includeEnd()
Replies if the current constant includes the end connection point.boolean
includeStart()
Replies if the current constant includes the start connection point.static RoadConnection.ClockwiseBoundType
valueOf(String name)
Returns the enum constant of this type with the specified name.static RoadConnection.ClockwiseBoundType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
EXCLUDE_START_SEGMENT
public static final RoadConnection.ClockwiseBoundType EXCLUDE_START_SEGMENT
The start segment is excluded from iterations. Caution, if the end segment is the same as the start segment, the segment is still replied as the last segment.
-
EXCLUDE_END_SEGMENT
public static final RoadConnection.ClockwiseBoundType EXCLUDE_END_SEGMENT
The end segment is excluded from iterations. Caution, if the end segment is the same as the start segment, the segment is still replied as the first segment.
-
EXCLUDE_BOTH
public static final RoadConnection.ClockwiseBoundType EXCLUDE_BOTH
The start and end segments are excluded from iterations.
-
INCLUDE_BOTH
public static final RoadConnection.ClockwiseBoundType INCLUDE_BOTH
The start and end segments are included into iterations.
-
-
Method Detail
-
values
public static RoadConnection.ClockwiseBoundType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (RoadConnection.ClockwiseBoundType c : RoadConnection.ClockwiseBoundType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static RoadConnection.ClockwiseBoundType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
includeStart
@Pure public boolean includeStart()
Replies if the current constant includes the start connection point.- Returns:
true
if this type of inclusion allows the start segment to be iterated, otherwisefalse
-
includeEnd
@Pure public boolean includeEnd()
Replies if the current constant includes the end connection point.- Returns:
true
if this type of inclusion allows the end segment to be iterated, otherwisefalse
-
-