org.ptolemy.fmi

Enum FMIScalarVariable.Variability

java.lang.Object

java.lang.Enum<FMIScalarVariable.Variability>

org.ptolemy.fmi.FMIScalarVariable.Variability

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FMIScalarVariable.Variability>

Enclosing class:

FMIScalarVariable

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

Acceptable values for the variability xml attribute. The variablity attribute defines when a value changes, which determines when the value should be read.

Enum Constant Summary

Enum Constants

Enum Constant and Description
constant The value does not change.
continuous The value changes at any moment.
discrete The value only changes during initialization and at event instances.
fixed FMI-2.0.
parameter The value does not change after initialization.
tunable The value is constant between external events.

Method Summary

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

constant

public static final FMIScalarVariable.Variability constant

The value does not change.

continuous

public static final FMIScalarVariable.Variability continuous

The value changes at any moment. A continuous variable must be of type Real. The default Variability is "continuous".

discrete

public static final FMIScalarVariable.Variability discrete

The value only changes during initialization and at event instances.

parameter

public static final FMIScalarVariable.Variability parameter

The value does not change after initialization.

fixed

public static final FMIScalarVariable.Variability fixed

FMI-2.0.

tunable

public static final FMIScalarVariable.Variability tunable

The value is constant between external events.

Method Detail

values

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