org.npsnet.xrti.proxies
Class HLAfederateState

java.lang.Object
  org.npsnet.xrti.proxies.HLAfederateState

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class HLAfederateState

extends java.lang.Object

implements java.lang.Cloneable, java.io.Serializable

State of the federate.

Author:

org.npsnet.xrti.utilities.ProxyCompiler

See Also:

Serialized Form

Field Summary

static HLAfederateState	ActiveFederate Enumerator #0.
static HLAfederateState	FederateRestoreInProgress Enumerator #2.
static HLAfederateState	FederateSaveInProgress Enumerator #1.
private int	value The value of the instance.

Constructor Summary

	HLAfederateState() Default constructor (ActiveFederate).
	HLAfederateState(HLAfederateState other) Copy constructor.
private	HLAfederateState(int pValue) Private constructor.

Method Summary

static HLAfederateState	decode(HLAEncodingInputStream hlaeis) Reads and returns a HLAfederateState from the specified stream.
void	encode(HLAEncodingOutputStream hlaeos) Writes this HLAfederateState to the specified stream.
boolean	equals(java.lang.Object other) Compares this HLAfederateState for equality with another.
int	hashCode() Computes and returns a hash code corresponding to this HLAfederateState.
java.lang.String	toString() Returns a string representation of this HLAfederateState

Methods inherited from class java.lang.Object

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

Field Detail

ActiveFederate

public static final HLAfederateState ActiveFederate

Enumerator #0.

FederateSaveInProgress

public static final HLAfederateState FederateSaveInProgress

Enumerator #1.

FederateRestoreInProgress

public static final HLAfederateState FederateRestoreInProgress

Enumerator #2.

value

private int value

The value of the instance.

Constructor Detail

HLAfederateState

public HLAfederateState()

Default constructor (ActiveFederate).

HLAfederateState

public HLAfederateState(HLAfederateState other)

Copy constructor.

Parameters:

other - the other HLAfederateState to copy

HLAfederateState

private HLAfederateState(int pValue)

Private constructor.

Parameters:

pValue - the instance value

Method Detail

decode

public static HLAfederateState decode(HLAEncodingInputStream hlaeis)
                               throws java.io.IOException

Reads and returns a HLAfederateState from the specified stream.

Parameters:

hlaeis - the input stream to read from

Returns:

the decoded value

Throws:

java.io.IOException - if an error occurs

equals

public boolean equals(java.lang.Object other)

Compares this HLAfederateState for equality with another.

Parameters:

other - the other HLAfederateState

Returns:

true if the two enumerated types are equal, false otherwise

hashCode

public int hashCode()

Computes and returns a hash code corresponding to this HLAfederateState.

Returns:

a hash code corresponding to this HLAfederateState

encode

public void encode(HLAEncodingOutputStream hlaeos)
            throws java.io.IOException

Writes this HLAfederateState to the specified stream.

Parameters:

hlaeos - the stream to write to

Throws:

java.io.IOException - if an error occurs

toString

public java.lang.String toString()

Returns a string representation of this HLAfederateState

Returns:

a string representation of this HLAfederateState