org.portico.shared.msg
Class FED_RemoveObject

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

All Implemented Interfaces:

Serializable

public class FED_RemoveObject
extends FED_CallbackMessage

This message is a notification that the object of the contained handle should be deleted. If the request contains a time, this message should not be delivered to the federate by the LRC until a time advance grant has been achieved for at least that time, if not further.

See Also:

Serialized Form

Field Summary

private int	objectHandle
private static long	serialVersionUID
private byte[]	tag

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

targetFederate, timestamp

Constructor Summary

FED_RemoveObject()

FED_RemoveObject(int objectHandle, byte[] tag)

FED_RemoveObject(int objectHandle, double time, byte[] tag)

Method Summary

int	getObjectHandle()
byte[]	getTag()
boolean	isSpecDefinedMessage() Is this callback type a "message" as defined in the HLA specification.
void	setObjectHandle(int objectHandle)
void	setTag(byte[] tag)

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

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

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

objectHandle

private int objectHandle

tag

private byte[] tag

Constructor Detail

FED_RemoveObject

public FED_RemoveObject()

FED_RemoveObject

public FED_RemoveObject(int objectHandle,
                        byte[] tag)

FED_RemoveObject

public FED_RemoveObject(int objectHandle,
                        double time,
                        byte[] tag)

Method Detail

getObjectHandle

public int getObjectHandle()

setObjectHandle

public void setObjectHandle(int objectHandle)

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