org.portico.shared.msg
Class RTI_ResignFederation

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

All Implemented Interfaces:

Serializable

public class RTI_ResignFederation
extends RTI_RequestMessage

Message to RTI that a resign should occur. The resign action should be passed to the constructor to allow checking to occur right from message creation. However, if the no-arg constructor is used, the default of ResignAction.NO_ACTION is applied. Ideally we'd be using a Java 5 type-safe enum, but we're in a world of legacy support here. Sigh.

See Also:

Serialized Form

Field Summary

private JResignAction	resignAction
private static long	serialVersionUID

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

targetFederate, timestamp

Constructor Summary

RTI_ResignFederation()

RTI_ResignFederation(JResignAction action)

Method Summary

JResignAction	getResignAction()
void	setResignAction(JResignAction action)

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

resignAction

private JResignAction resignAction

Constructor Detail

RTI_ResignFederation

public RTI_ResignFederation()

RTI_ResignFederation

public RTI_ResignFederation(JResignAction action)
                     throws JInvalidResignAction

Throws:

JInvalidResignAction

Method Detail

getResignAction

public JResignAction getResignAction()

setResignAction

public void setResignAction(JResignAction action)