Package org.opentcs.data.model

Enum Point.Type

java.lang.Object
java.lang.Enum<Point.Type>
org.opentcs.data.model.Point.Type
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Point.Type>, java.lang.constant.Constable
Enclosing class:
Point
public static enum Point.Type
extends java.lang.Enum<Point.Type>
Describes the types of positions in a driving course.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    HALT_POSITION
    Indicates a position at which a vehicle may halt temporarily, e.g. for executing an operation.
    PARK_POSITION
    Indicates a position at which a vehicle may halt for longer periods of time when it is not processing orders.
    REPORT_POSITION
    Indicates a position at which a vehicle is expected to report in.

  • Method Summary

    Modifier and Type Method Description
    static Point.Type valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static Point.Type[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • REPORT_POSITION

      public static final Point.Type REPORT_POSITION
      Indicates a position at which a vehicle is expected to report in. Halting or even parking at such a position is not allowed.

    • HALT_POSITION

      public static final Point.Type HALT_POSITION
      Indicates a position at which a vehicle may halt temporarily, e.g. for executing an operation. The vehicle is also expected to report in when it arrives at such a position. It may not park here for longer than necessary, though.

    • PARK_POSITION

      public static final Point.Type PARK_POSITION
      Indicates a position at which a vehicle may halt for longer periods of time when it is not processing orders. The vehicle is also expected to report in when it arrives at such a position.

  • Method Details

    • values

      public static Point.Type[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Point.Type valueOf​(java.lang.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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null