org.openmi.standard
Enum IEvent.EventType

java.lang.Object
  java.lang.Enum<IEvent.EventType>
      org.openmi.standard.IEvent.EventType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IEvent.EventType>

Enclosing interface:

IEvent

public static enum IEvent.EventType
extends java.lang.Enum<IEvent.EventType>

Enumeration for event types.

Enum Constant Summary

DataChanged
Data changed.

GlobalProgress
Global progress.

Informative
Informative.

Other
Other.

SourceAfterGetValuesCall
Source after GetValues call.

SourceBeforeGetValuesReturn
Source before GetValues return.

TargetAfterGetValuesReturn
Target after GetValues return.

TargetBeforeGetValuesCall
Target before GetValues call.

TimeStepProgress
Timestep progress.

ValueOutOfRange
Value out of range.

Warning
Warning.

Method Summary

int	getValue() int flag value to a given enum base type.
IEvent.EventType[]	toArray()
static IEvent.EventType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IEvent.EventType[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Warning

public static final IEvent.EventType Warning

Warning.

Informative

public static final IEvent.EventType Informative

Informative. Any type of information.

ValueOutOfRange

public static final IEvent.EventType ValueOutOfRange

Value out of range. If a LinkableComponent receives values through the GetValues method, which are detected by the receiving component as out-of-range an OutOfRange event must be send. Alternatively, if the component cannot proceed with the received value or if proceeding with the received value will make the component unstable or make the component generate erroneous results and exception can be thrown.

GlobalProgress

public static final IEvent.EventType GlobalProgress

Global progress. Indicates progress as percentage of global time horizon. It is not mandatory for LinkableComponent to provide this event type.

TimeStepProgress

public static final IEvent.EventType TimeStepProgress

Timestep progress. Indicates progress as % for the current time step. It is not mandatory for LinkableComponent to provide this event type.

DataChanged

public static final IEvent.EventType DataChanged

Data changed. Events of this event type must be send at least once during each period when the LinkableComponent hold the thread if the internal state of the component has changed.

TargetBeforeGetValuesCall

public static final IEvent.EventType TargetBeforeGetValuesCall

Target before GetValues call. Immediately before a LinkableComponent invokes the GetValues method in another LinkableComponent an event of type TargetBeforeGetValuesCall must be send.

SourceAfterGetValuesCall

public static final IEvent.EventType SourceAfterGetValuesCall

Source after GetValues call. Immediately when the GetValues method is invoked in a LinkableComponent this component must send an event of type SourceAfterGetValuesCall

SourceBeforeGetValuesReturn

public static final IEvent.EventType SourceBeforeGetValuesReturn

Source before GetValues return. Immediately before a LinkableComponent in which the GetValues method has been invoked returns the thread to the calling component an event of type SourceBeforeGetValuesReturn must be send.

TargetAfterGetValuesReturn

public static final IEvent.EventType TargetAfterGetValuesReturn

Target after GetValues return. Immediately after a LinkableComponent which has invoked the GetValues method in another LinkableComponent receives the thread back from this component (after this component returns the values) an event of type TargetAfterGetValuesReturn must be send.

Other

public static final IEvent.EventType Other

Other. Any other event that is found useful to implement.

Method Detail

values

public static final IEvent.EventType[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(IEvent.EventType c : IEvent.EventType.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static IEvent.EventType 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

getValue

public int getValue()

int flag value to a given enum base type.

Returns:

The integer flag value

toArray

public IEvent.EventType[] toArray()