Package org.ptolemy.fmi

Enum FMIScalarVariable.Alias

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FMIScalarVariable.Alias>
    Enclosing class:
    FMIScalarVariable
    public static enum FMIScalarVariable.Alias
extends java.lang.Enum<FMIScalarVariable.Alias>
    Acceptable values for the alias xml attribute. Alias variables occur during assignment operations.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      alias
      This is an alias variable, use the valueReference handle to set or get the actual value.
      negatedAlias
      This is an alias value, but the value returned must be negated.
      noAlias
      This is not an alias (the default).

    • Method Summary

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

      • alias

        public static final FMIScalarVariable.Alias alias
        This is an alias variable, use the valueReference handle to set or get the actual value.

      • negatedAlias

        public static final FMIScalarVariable.Alias negatedAlias
        This is an alias value, but the value returned must be negated.

    • Method Detail

      • values

        public static FMIScalarVariable.Alias[] 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.Alias c : FMIScalarVariable.Alias.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.Alias 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