Package org.opentrafficsim.road.gtu.strategical.od

Enum Interpolation

java.lang.Object
java.lang.Enum<Interpolation>
org.opentrafficsim.road.gtu.strategical.od.Interpolation
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Interpolation>, java.lang.constant.Constable
public enum Interpolation
extends java.lang.Enum<Interpolation>
Interpolation of demand.

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.

Version:
$Revision$, $LastChangedDate$, by $Author$, initial version Sep 15, 2016
Author:
Alexander Verbraeck, Peter Knoppers, Wouter Schakel

  • 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
    LINEAR
    Linear interpolation of demand.
    STEPWISE
    Stepwise interpolation of demand.

  • Method Summary

    Modifier and Type Method Description
    Frequency interpolateVector​(Time time, FrequencyVector demandVector, TimeVector timeVector, boolean sliceStart)
    Returns interpolated value from array at given time.
    boolean isLinear()  
    boolean isStepWise()  
    static Interpolation valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static Interpolation[] 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

  • Method Details

    • values

      public static Interpolation[] 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 Interpolation 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

    • isStepWise

      public boolean isStepWise()
      Returns:
      whether this is step-wise interpolation

    • isLinear

      public boolean isLinear()
      Returns:
      whether this is linear interpolation

    • interpolateVector

      public final Frequency interpolateVector​(Time time, FrequencyVector demandVector, TimeVector timeVector, boolean sliceStart)
      Returns interpolated value from array at given time. If time is outside of the vector range, 0 is returned.
      Parameters:
      time - Time; time to determine the frequency at
      demandVector - FrequencyVector; demand vector
      timeVector - TimeVector; time vector
      sliceStart - boolean; whether the time is at the start of an arbitrary time slice
      Returns:
      interpolated value from array at given time, or 0 when time is outside of range