org.portico.shared.msg
Class FED_ReceiveInteraction

java.lang.Object
  com.lbf.commons.messaging.RequestMessage
      org.portico.shared.msg.FED_CallbackMessage
          org.portico.shared.msg.FED_ReceiveInteraction

All Implemented Interfaces:

Externalizable, Serializable

public class FED_ReceiveInteraction
extends FED_CallbackMessage
implements Externalizable

Callback to inform the target federate that an interaction it is subscribed to has been sent. The included parameter values, tag and id of the interaction class are provided.

See Also:

Serialized Form

Field Summary

private int	interactionId
private HashMap<Integer,byte[]>	parameters
private static long	serialVersionUID
private byte[]	tag

Fields inherited from class org.portico.shared.msg.FED_CallbackMessage

targetFederate, timestamp

Constructor Summary

FED_ReceiveInteraction()

FED_ReceiveInteraction(int interacitonId, byte[] tag, HashMap<Integer,byte[]> parameters)

FED_ReceiveInteraction(int interactionId, byte[] tag, HashMap<Integer,byte[]> parameters, double time)

Method Summary

int	getInteractionId()
HashMap<Integer,byte[]>	getParameters()
byte[]	getTag()
boolean	isSpecDefinedMessage() Is this callback type a "message" as defined in the HLA specification.
void	readExternal(ObjectInput input)
void	setInteractionId(int interactionId)
void	setParameters(HashMap<Integer,byte[]> parameters)
void	setTag(byte[] tag)
void	writeExternal(ObjectOutput output)

Methods inherited from class org.portico.shared.msg.FED_CallbackMessage

getTargetFederate, getTimestamp, isAdvanceGrant, isPriority, isTimestamped, setTargetFederate, setTimestamp

Methods inherited from class com.lbf.commons.messaging.RequestMessage

getIdentifier, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

interactionId

private int interactionId

tag

private byte[] tag

parameters

private HashMap<Integer,byte[]> parameters

Constructor Detail

FED_ReceiveInteraction

public FED_ReceiveInteraction()

FED_ReceiveInteraction

public FED_ReceiveInteraction(int interacitonId,
                              byte[] tag,
                              HashMap<Integer,byte[]> parameters)

FED_ReceiveInteraction

public FED_ReceiveInteraction(int interactionId,
                              byte[] tag,
                              HashMap<Integer,byte[]> parameters,
                              double time)

Method Detail

getInteractionId

public int getInteractionId()

setInteractionId

public void setInteractionId(int interactionId)

getParameters

public HashMap<Integer,byte[]> getParameters()

setParameters

public void setParameters(HashMap<Integer,byte[]> parameters)

getTag

public byte[] getTag()

setTag

public void setTag(byte[] tag)

isSpecDefinedMessage

public boolean isSpecDefinedMessage()

Description copied from class: FED_CallbackMessage

Is this callback type a "message" as defined in the HLA specification. The specification defines "messages" as follows:

 3.1.51 message: A change of object instance attribute value, an interaction, or a deletion
                 of an existing object instance, often associated with a particular point on
                 the High Level Architecture (HLA) time axis, as denoted by the associated
                 timestamp.
 

Overrides:

isSpecDefinedMessage in class FED_CallbackMessage

Returns:

Defaults to return false. Should be overridden to return true in any message type that requires it

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class FED_CallbackMessage

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class FED_CallbackMessage

Throws:

IOException