Package org.ptolemy.fmi

Enum FMIScalarVariable.Initial

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FMIScalarVariable.Initial>
    Enclosing class:
    FMIScalarVariable
    public static enum FMIScalarVariable.Initial
extends java.lang.Enum<FMIScalarVariable.Initial>
    Acceptable values for the initial xml attribute. The initial xml attribute defines how the variable is initialized.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      approx
      The variable is an iteration variable of an algebraic loop and the iteration at initialization starts with the start value.
      calculated
      The variable is calculated from other variables during initialization.
      exact
      The variable is initialized with the start value (provided under Real, Integer, Boolean, String or Enumeration".
      notPresent
      Not present.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static FMIScalarVariable.Initial valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static FMIScalarVariable.Initial[] 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

      • approx

        public static final FMIScalarVariable.Initial approx
        The variable is an iteration variable of an algebraic loop and the iteration at initialization starts with the start value.

      • calculated

        public static final FMIScalarVariable.Initial calculated
        The variable is calculated from other variables during initialization. It is not allowed to provide a "start" value.

      • exact

        public static final FMIScalarVariable.Initial exact
        The variable is initialized with the start value (provided under Real, Integer, Boolean, String or Enumeration".

    • Method Detail

      • values

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

      • valueOf

        public static FMIScalarVariable.Initial 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