Package org.opentrafficsim.core.gtu

Enum GTUDirectionality

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<GTUDirectionality>
    public enum GTUDirectionality
extends java.lang.Enum<GTUDirectionality>
    Longitudinal driving directions for a GTU. The driving directions can be used on a link or a lane. The two possible values are DIR_PLUS and DIR_MINUS.

    Copyright (c) 2013-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
    BSD-style license. See OpenTrafficSim License.

    $LastChangedDate: 2015-11-11 13:25:26 +0100 (Wed, 11 Nov 2015) $, @version $Revision: 1548 $, by $Author: averbraeck $, initial version Nov 11, 2015

    Author:
    Alexander Verbraeck, Peter Knoppers

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DIR_MINUS
      Driving direction opposite to the direction of the graph, decreasing fractional position when driving in this direction.
      DIR_PLUS
      Driving direction matches the direction of the graph, increasing fractional position when driving in this direction.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      GTUDirectionality flip()
      Returns the flipped direction.
      boolean isMinus()  
      boolean isPlus()  
      static GTUDirectionality valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static GTUDirectionality[] 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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • DIR_PLUS

        public static final GTUDirectionality DIR_PLUS
        Driving direction matches the direction of the graph, increasing fractional position when driving in this direction.

      • DIR_MINUS

        public static final GTUDirectionality DIR_MINUS
        Driving direction opposite to the direction of the graph, decreasing fractional position when driving in this direction.

    • Method Detail

      • values

        public static GTUDirectionality[] 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 (GTUDirectionality c : GTUDirectionality.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static GTUDirectionality 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

      • isPlus

        public boolean isPlus()
        Returns:
        whether the gtu drives in the design direction on the link

      • isMinus

        public boolean isMinus()
        Returns:
        whether the gtu drives against the design direction on the link

      • flip

        public GTUDirectionality flip()
        Returns the flipped direction.
        Returns:
        GTUDirectionality; flipped direction.