org.eodisp.wrapper.hla
Enum FederationState

java.lang.Object
  java.lang.Enum<FederationState>
      org.eodisp.wrapper.hla.FederationState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FederationState>

public enum FederationState
extends java.lang.Enum<FederationState>

Version:

$Id:$

 
                                                                        
                                                                        .---------------------------------------------------------------.
                                                                        |                                                               |
                                                                        |      .-------------------------------------------.            |
                                                                        |      |                       STEPPING            |            |
                                                                        |      |                        ^    |             |            |
                                                                        |      |                 step() |    |             |            |
                    init()                             start()          |      V    pause()             |    v  resume()   |            |
    NOT_INITIALIZED ---»  INITIALIZING ----» INITIALIZED ---» STARTING -|-» STARTED ---»  PAUSING  --»  PAUSED -------» RESUMING        |
                                                                        |                                                               |
                                                                        '---------------------------------------------------------------'
                                                                                                       |    
                                                                                                       |
                                                                                                       v      
                                                                                                    STOPPED       
                                                                           
                                                                            (From anywhere at anytime) ---> ERROR ---.
                                                                                                              A      |
                                                                                                              |______|
                                                                                      
 

Author:

ibirrer

Enum Constant Summary

ERROR
If an error occurred in this federate

INITIALIZED
All participating federates have registered with the control federate

INITIALIZING
The federate initializes.

NOT_INITIALIZED
The federate has not started

PAUSED
The federation synchronized at EODISP_PAUSE or EODISP_STEP

PAUSING
The synchronization point EODISP_PAUSE is registered

RESUMING
The synchronization point EODISP_RESUME is registered

STARTED
The federation synchronized at EODISP_START or EODISP_RESUME

STARTING
The synchronization point EODISP_START is registered

STEPPING
The synchronization point EODISP_STEP is registered

STOPPED
The federation synchronized at EOSISP_STOP

Method Summary

boolean	isStateChangeAllowed(FederationState newState)
static FederationState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FederationState[]	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

NOT_INITIALIZED

public static final FederationState NOT_INITIALIZED

The federate has not started

INITIALIZING

public static final FederationState INITIALIZING

The federate initializes.

INITIALIZED

public static final FederationState INITIALIZED

All participating federates have registered with the control federate

STARTING

public static final FederationState STARTING

The synchronization point EODISP_START is registered

STARTED

public static final FederationState STARTED

The federation synchronized at EODISP_START or EODISP_RESUME

PAUSING

public static final FederationState PAUSING

The synchronization point EODISP_PAUSE is registered

PAUSED

public static final FederationState PAUSED

The federation synchronized at EODISP_PAUSE or EODISP_STEP

STEPPING

public static final FederationState STEPPING

The synchronization point EODISP_STEP is registered

RESUMING

public static final FederationState RESUMING

The synchronization point EODISP_RESUME is registered

STOPPED

public static final FederationState STOPPED

The federation synchronized at EOSISP_STOP

ERROR

public static final FederationState ERROR

If an error occurred in this federate

Method Detail

values

public static FederationState[] 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 (FederationState c : FederationState.values())
    System.out.println(c);

Returns:

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

valueOf

public static FederationState 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

isStateChangeAllowed

public boolean isStateChangeAllowed(FederationState newState)