org.npsnet.xrti.proxies
Class HLAbootstrapInteractionPayload

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class HLAbootstrapInteractionPayload

extends java.lang.Object

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

The payload of the bootstrap interaction.

Author:

org.npsnet.xrti.utilities.ProxyCompiler

See Also:

Serialized Form

Field Summary

private long	federationExecutionHandle Federation execution handle.
private long	interactionClassHandle Interaction class handle.
private HLAparameterHandleValuePair[]	parameterHandleValuePairList List of parameter handle/value pairs.
private HLAorderType	sentOrdering The type of ordering with which the interaction was sent.
private byte[]	theTime The logical time associated with the interaction
private byte[]	userSuppliedTag User-supplied tag associated with the interaction.

Constructor Summary

HLAbootstrapInteractionPayload()
Default constructor.

HLAbootstrapInteractionPayload(HLAbootstrapInteractionPayload other)
Copy constructor.

HLAbootstrapInteractionPayload(long pFederationExecutionHandle, byte[] pUserSuppliedTag, long pInteractionClassHandle, HLAparameterHandleValuePair[] pParameterHandleValuePairList, HLAorderType pSentOrdering, byte[] pTheTime)
Constructor.

Method Summary

static HLAbootstrapInteractionPayload	decode(HLAEncodingInputStream hlaeis) Reads and returns a HLAbootstrapInteractionPayload from the specified stream.
void	encode(HLAEncodingOutputStream hlaeos) Writes this HLAbootstrapInteractionPayload to the specified stream.
long	getFederationExecutionHandle() Returns the value of the federationExecutionHandle field.
long	getInteractionClassHandle() Returns the value of the interactionClassHandle field.
HLAparameterHandleValuePair[]	getParameterHandleValuePairList() Returns the value of the parameterHandleValuePairList field.
HLAorderType	getSentOrdering() Returns the value of the sentOrdering field.
byte[]	getTheTime() Returns the value of the theTime field.
byte[]	getUserSuppliedTag() Returns the value of the userSuppliedTag field.
void	setFederationExecutionHandle(long pFederationExecutionHandle) Sets the value of the federationExecutionHandle field.
void	setInteractionClassHandle(long pInteractionClassHandle) Sets the value of the interactionClassHandle field.
void	setParameterHandleValuePairList(HLAparameterHandleValuePair[] pParameterHandleValuePairList) Sets the value of the parameterHandleValuePairList field.
void	setSentOrdering(HLAorderType pSentOrdering) Sets the value of the sentOrdering field.
void	setTheTime(byte[] pTheTime) Sets the value of the theTime field.
void	setUserSuppliedTag(byte[] pUserSuppliedTag) Sets the value of the userSuppliedTag field.
java.lang.String	toString() Returns a string representation of this HLAbootstrapInteractionPayload.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

federationExecutionHandle

private long federationExecutionHandle

Federation execution handle.

userSuppliedTag

private byte[] userSuppliedTag

User-supplied tag associated with the interaction.

interactionClassHandle

private long interactionClassHandle

Interaction class handle.

parameterHandleValuePairList

private HLAparameterHandleValuePair[] parameterHandleValuePairList

List of parameter handle/value pairs.

sentOrdering

private HLAorderType sentOrdering

The type of ordering with which the interaction was sent.

theTime

private byte[] theTime

The logical time associated with the interaction

Constructor Detail

HLAbootstrapInteractionPayload

public HLAbootstrapInteractionPayload()

Default constructor.

HLAbootstrapInteractionPayload

public HLAbootstrapInteractionPayload(long pFederationExecutionHandle,
                                      byte[] pUserSuppliedTag,
                                      long pInteractionClassHandle,
                                      HLAparameterHandleValuePair[] pParameterHandleValuePairList,
                                      HLAorderType pSentOrdering,
                                      byte[] pTheTime)

Constructor.

Parameters:

pFederationExecutionHandle - the value of the federationExecutionHandle field

pUserSuppliedTag - the value of the userSuppliedTag field

pInteractionClassHandle - the value of the interactionClassHandle field

pParameterHandleValuePairList - the value of the parameterHandleValuePairList field

pSentOrdering - the value of the sentOrdering field

pTheTime - the value of the theTime field

HLAbootstrapInteractionPayload

public HLAbootstrapInteractionPayload(HLAbootstrapInteractionPayload other)

Copy constructor.

Parameters:

other - the other HLAbootstrapInteractionPayload to copy

Method Detail

decode

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

Reads and returns a HLAbootstrapInteractionPayload from the specified stream.

Parameters:

hlaeis - the input stream to read from

Returns:

the decoded value

Throws:

java.io.IOException - if an error occurs

encode

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

Writes this HLAbootstrapInteractionPayload to the specified stream.

Parameters:

hlaeos - the output stream to write to

Throws:

java.io.IOException - if an error occurs

toString

public java.lang.String toString()

Returns a string representation of this HLAbootstrapInteractionPayload.

Returns:

a string representation of this HLAbootstrapInteractionPayload

setFederationExecutionHandle

public void setFederationExecutionHandle(long pFederationExecutionHandle)

Sets the value of the federationExecutionHandle field.

Parameters:

pFederationExecutionHandle - the new value for the field

getFederationExecutionHandle

public long getFederationExecutionHandle()

Returns the value of the federationExecutionHandle field.

Returns:

the value of the federationExecutionHandle field

setUserSuppliedTag

public void setUserSuppliedTag(byte[] pUserSuppliedTag)

Sets the value of the userSuppliedTag field.

Parameters:

pUserSuppliedTag - the new value for the field

getUserSuppliedTag

public byte[] getUserSuppliedTag()

Returns the value of the userSuppliedTag field.

Returns:

the value of the userSuppliedTag field

setInteractionClassHandle

public void setInteractionClassHandle(long pInteractionClassHandle)

Sets the value of the interactionClassHandle field.

Parameters:

pInteractionClassHandle - the new value for the field

getInteractionClassHandle

public long getInteractionClassHandle()

Returns the value of the interactionClassHandle field.

Returns:

the value of the interactionClassHandle field

setParameterHandleValuePairList

public void setParameterHandleValuePairList(HLAparameterHandleValuePair[] pParameterHandleValuePairList)

Sets the value of the parameterHandleValuePairList field.

Parameters:

pParameterHandleValuePairList - the new value for the field

getParameterHandleValuePairList

public HLAparameterHandleValuePair[] getParameterHandleValuePairList()

Returns the value of the parameterHandleValuePairList field.

Returns:

the value of the parameterHandleValuePairList field

setSentOrdering

public void setSentOrdering(HLAorderType pSentOrdering)

Sets the value of the sentOrdering field.

Parameters:

pSentOrdering - the new value for the field

getSentOrdering

public HLAorderType getSentOrdering()

Returns the value of the sentOrdering field.

Returns:

the value of the sentOrdering field

setTheTime

public void setTheTime(byte[] pTheTime)

Sets the value of the theTime field.

Parameters:

pTheTime - the new value for the field

getTheTime

public byte[] getTheTime()

Returns the value of the theTime field.

Returns:

the value of the theTime field