org.ptolemy.fmi
Enum FMIScalarVariable.Causality

java.lang.Object
  extended by java.lang.Enum<FMIScalarVariable.Causality>
      extended by org.ptolemy.fmi.FMIScalarVariable.Causality
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<FMIScalarVariable.Causality>
Enclosing class:
FMIScalarVariable

public static enum FMIScalarVariable.Causality
extends java.lang.Enum<FMIScalarVariable.Causality>

Acceptable values for the causality xml attribute. Causality defines the visibility of the variable from outside of the model.


Enum Constant Summary
input
          The value is defined from the outside.
internal
          After initialization, a result may be stored.
none
          The value does not affect computation.
output
          The value can be read from the outside with a connection.
 
Method Summary
static FMIScalarVariable.Causality valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static FMIScalarVariable.Causality[] 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

input

public static final FMIScalarVariable.Causality input
The value is defined from the outside. The value is initially the value of the start attribute.


internal

public static final FMIScalarVariable.Causality internal
After initialization, a result may be stored. However, the value cannot be used in a connection. The default Causality is "internal".


output

public static final FMIScalarVariable.Causality output
The value can be read from the outside with a connection.


none

public static final FMIScalarVariable.Causality none
The value does not affect computation. Typically, "none" values are tool specific and used to enable logging.

Method Detail

values

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