Package net.simplace.sim.io

Enum Class FWSimIOAdapter.FREQUENCE

java.lang.Object
java.lang.Enum<FWSimIOAdapter.FREQUENCE>
net.simplace.sim.io.FWSimIOAdapter.FREQUENCE
All Implemented Interfaces:
Serializable, Comparable<FWSimIOAdapter.FREQUENCE>, Constable
Enclosing class:
FWSimIOAdapter
public static enum FWSimIOAdapter.FREQUENCE extends Enum<FWSimIOAdapter.FREQUENCE>
FREQUENCE the data is written, accessed, used or updated in the different adapters
Author:
Andreas Enders

  • Nested Class Summary

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

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BOOLEAN
    Complex - data accessed in a complex order. only variable names containing boolean variable are supported
    CAL
    Output is only performed when calibration has ended
    COMPLEX
    Complex - data accessed in a complex order. please use rule to specify in more detail
    DAILY
    Daily frequency - data accessed in every time step if time step == daily
    END
    Data only once written at the end of the simulation phase of the model run
    EXCHANGE
    Output is only performed when data exchange is taking place
    MONTHLY
    Monthly - data accessed only yearly always at the last day of the month
    NON
    No frequency means no update - data accessed only once at the initialization phase of the model run
    ONCE
    No frequency means no update - data accessed only once at the initialization phase of the model run
    YEARLY
    Yearly - data accessed only yearly always at the 31 December of the year

  • Method Summary

    Modifier and Type
    Method
    Description
    static FWSimIOAdapter.FREQUENCE
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static FWSimIOAdapter.FREQUENCE[]
    values()
    Returns an array containing the constants of this enum class, 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

    • NON

      public static final FWSimIOAdapter.FREQUENCE NON
      No frequency means no update - data accessed only once at the initialization phase of the model run

    • DAILY

      public static final FWSimIOAdapter.FREQUENCE DAILY
      Daily frequency - data accessed in every time step if time step == daily

    • YEARLY

      public static final FWSimIOAdapter.FREQUENCE YEARLY
      Yearly - data accessed only yearly always at the 31 December of the year

    • COMPLEX

      public static final FWSimIOAdapter.FREQUENCE COMPLEX
      Complex - data accessed in a complex order. please use rule to specify in more detail

    • BOOLEAN

      public static final FWSimIOAdapter.FREQUENCE BOOLEAN
      Complex - data accessed in a complex order. only variable names containing boolean variable are supported

    • MONTHLY

      public static final FWSimIOAdapter.FREQUENCE MONTHLY
      Monthly - data accessed only yearly always at the last day of the month

    • ONCE

      public static final FWSimIOAdapter.FREQUENCE ONCE
      No frequency means no update - data accessed only once at the initialization phase of the model run

    • END

      public static final FWSimIOAdapter.FREQUENCE END
      Data only once written at the end of the simulation phase of the model run

    • CAL

      public static final FWSimIOAdapter.FREQUENCE CAL
      Output is only performed when calibration has ended

    • EXCHANGE

      public static final FWSimIOAdapter.FREQUENCE EXCHANGE
      Output is only performed when data exchange is taking place

  • Method Details

    • values

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

    • valueOf

      public static FWSimIOAdapter.FREQUENCE valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null