org.portico.shared.msg
Class RTI_UnsubscribeInteractionClass

java.lang.Object
  com.lbf.commons.messaging.RequestMessage
      org.portico.shared.msg.RTI_RequestMessage
          org.portico.shared.msg.RTI_UnsubscribeInteractionClass

All Implemented Interfaces:

Serializable

public class RTI_UnsubscribeInteractionClass
extends RTI_RequestMessage

This message class represents an interaction unsubscription request. It contains the interaction class handle that should be unsubscribed from, along with an optional region token (if the subscription is supplying region data). If there is no region data associated with the unsubscribe request, the default value of the region token will be PorticoConstants.NULL_HANDLE.

See Also:

Serialized Form

Field Summary

private int	classHandle
private int	regionToken
private static long	serialVersionUID

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

targetFederate, timestamp

Constructor Summary

RTI_UnsubscribeInteractionClass()

RTI_UnsubscribeInteractionClass(int classHandle)

RTI_UnsubscribeInteractionClass(int classHandle, int regionToken)

Method Summary

int	getClassHandle()
int	getRegionToken()
void	setClassHandle(int classHandle)
void	setRegionToken(int regionToken)
boolean	usesDDM() Returns true is DDM information has been supplied with this message, false if it is just a vanilla unsubscribe request.

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

bytesToString, getTargetFederate, getTimestamp, isTimestamped, readExternal, setTargetFederate, setTimestamp, stringToBytes, 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

classHandle

private int classHandle

regionToken

private int regionToken

Constructor Detail

RTI_UnsubscribeInteractionClass

public RTI_UnsubscribeInteractionClass()

RTI_UnsubscribeInteractionClass

public RTI_UnsubscribeInteractionClass(int classHandle)

RTI_UnsubscribeInteractionClass

public RTI_UnsubscribeInteractionClass(int classHandle,
                                       int regionToken)

Method Detail

getClassHandle

public int getClassHandle()

setClassHandle

public void setClassHandle(int classHandle)

getRegionToken

public int getRegionToken()

setRegionToken

public void setRegionToken(int regionToken)

usesDDM

public boolean usesDDM()

Returns true is DDM information has been supplied with this message, false if it is just a vanilla unsubscribe request.