com.mak.vrlj.interaction.AcknowledgeInteraction Class Reference

Acknowledge message between entities. More...

Inheritance diagram for com.mak.vrlj.interaction.AcknowledgeInteraction:

Collaboration diagram for com.mak.vrlj.interaction.AcknowledgeInteraction:

Public Member Functions
boolean	equals (Object obj)
AcknowledgeFlag	getAcknowledgeFlag ()
GlobalObjectDesignator	getReceiverId ()
int	getRequestId ()
ResponseFlag	getResponseFlag ()
GlobalObjectDesignator	getSenderId ()
int	hashCode ()
void	setAcknowledgeFlag (AcknowledgeFlag acknowledgeFlag)
void	setReceiverId (GlobalObjectDesignator receiverId)
void	setRequestId (int reqId)
void	setResponseFlag (ResponseFlag respFlag)
void	setSenderId (GlobalObjectDesignator senderId)
String	toString ()
String	getInteractionName ()
Public Member Functions inherited from com.mak.vrlj.interaction.BaseInteraction
double	getTimeStamp ()
void	setTimeStamp (double ts)

Static Public Member Functions
static InteractionListener < AcknowledgeInteraction >	addListener (ExerciseConnection exConn, InteractionListener< AcknowledgeInteraction > listener)
	Subscribe for callbacks when new interactions are received over the specified ExerciseConnection.
static void	removeListener (ExerciseConnection exConn, InteractionListener< AcknowledgeInteraction > listener)
	Remove a subscription for interactions callbacks on an ExerciseConnection.

Static Public Attributes
static final String	NAME = ":Acknowledge"
	Interaction class name.

Private Attributes
GlobalObjectDesignator	mySenderId = new GlobalObjectDesignator("")
GlobalObjectDesignator	myReceiverId = new GlobalObjectDesignator("")
int	myRequestId
AcknowledgeFlag	myAcknowledgeFlag = AcknowledgeFlag.EMPTY
ResponseFlag	myResponseFlag = ResponseFlag.NOWAY

Detailed Description

Acknowledge message between entities.

Member Function Documentation

static InteractionListener<AcknowledgeInteraction> com.mak.vrlj.interaction.AcknowledgeInteraction.addListener ( ExerciseConnection  exConn, InteractionListener< AcknowledgeInteraction >  listener  )

inlinestatic

Subscribe for callbacks when new interactions are received over the specified ExerciseConnection.

Parameters

exConn	ExerciseConnection to listen to.
listener	callback receiver.

Returns

the listener argument, for call chaining.

References com.mak.vrlj.vl.ExerciseConnection.addInteractionListener(), and com.mak.vrlj.interaction.AcknowledgeInteraction.NAME.

boolean com.mak.vrlj.interaction.AcknowledgeInteraction.equals ( Object  obj )

inline

References com.mak.vrlj.object.GlobalObjectDesignator.equals(), com.mak.vrlj.interaction.AcknowledgeInteraction.myAcknowledgeFlag, com.mak.vrlj.interaction.AcknowledgeInteraction.myReceiverId, com.mak.vrlj.interaction.AcknowledgeInteraction.myRequestId, com.mak.vrlj.interaction.AcknowledgeInteraction.myResponseFlag, and com.mak.vrlj.interaction.AcknowledgeInteraction.mySenderId.

AcknowledgeFlag com.mak.vrlj.interaction.AcknowledgeInteraction.getAcknowledgeFlag ( )

inline

Returns

the type of munition fired.

References com.mak.vrlj.interaction.AcknowledgeInteraction.myAcknowledgeFlag.

String com.mak.vrlj.interaction.AcknowledgeInteraction.getInteractionName ( )

inlinevirtual

Implements com.mak.vrlj.interaction.Interaction.

References com.mak.vrlj.interaction.AcknowledgeInteraction.NAME.

GlobalObjectDesignator com.mak.vrlj.interaction.AcknowledgeInteraction.getReceiverId ( )

inline

Returns

GlobalObjectDesignator of the Receiver entity.

References com.mak.vrlj.interaction.AcknowledgeInteraction.myReceiverId.

int com.mak.vrlj.interaction.AcknowledgeInteraction.getRequestId ( )

inline

Returns

the value for the request.

References com.mak.vrlj.interaction.AcknowledgeInteraction.myRequestId.

ResponseFlag com.mak.vrlj.interaction.AcknowledgeInteraction.getResponseFlag ( )

inline

Returns

the ResponseFlag used by the munition fired.

References com.mak.vrlj.interaction.AcknowledgeInteraction.myResponseFlag.

GlobalObjectDesignator com.mak.vrlj.interaction.AcknowledgeInteraction.getSenderId ( )

inline

Returns

GlobalObjectDesignator of the Sender entity.

References com.mak.vrlj.interaction.AcknowledgeInteraction.mySenderId.

int com.mak.vrlj.interaction.AcknowledgeInteraction.hashCode ( )

inline

References com.mak.vrlj.interaction.AcknowledgeInteraction.myAcknowledgeFlag, com.mak.vrlj.interaction.AcknowledgeInteraction.myReceiverId, com.mak.vrlj.interaction.AcknowledgeInteraction.myRequestId, com.mak.vrlj.interaction.AcknowledgeInteraction.myResponseFlag, and com.mak.vrlj.interaction.AcknowledgeInteraction.mySenderId.

static void com.mak.vrlj.interaction.AcknowledgeInteraction.removeListener ( ExerciseConnection  exConn, InteractionListener< AcknowledgeInteraction >  listener  )

inlinestatic

Remove a subscription for interactions callbacks on an ExerciseConnection.

Parameters

exConn	ExerciseConnection listened to.
listener	the callback to remove.

References com.mak.vrlj.interaction.AcknowledgeInteraction.NAME, and com.mak.vrlj.vl.ExerciseConnection.removeInteractionListener().

void com.mak.vrlj.interaction.AcknowledgeInteraction.setAcknowledgeFlag ( AcknowledgeFlag  acknowledgeFlag )

inline

Parameters

acknowledgeFlag

the type of munition fired.

References com.mak.vrlj.interaction.AcknowledgeInteraction.myAcknowledgeFlag.

void com.mak.vrlj.interaction.AcknowledgeInteraction.setReceiverId ( GlobalObjectDesignator  receiverId )

inline

Parameters

receiverId

GlobalObjectDesignator of the Receiver entity.

References com.mak.vrlj.interaction.AcknowledgeInteraction.myReceiverId.

void com.mak.vrlj.interaction.AcknowledgeInteraction.setRequestId ( int  reqId )

inline

Parameters

reqId

id of the request event.

References com.mak.vrlj.interaction.AcknowledgeInteraction.myRequestId.

void com.mak.vrlj.interaction.AcknowledgeInteraction.setResponseFlag ( ResponseFlag  respFlag )

inline

Parameters

respFlag

the ResponseFlag used by the munition fired.

References com.mak.vrlj.interaction.AcknowledgeInteraction.myResponseFlag.

void com.mak.vrlj.interaction.AcknowledgeInteraction.setSenderId ( GlobalObjectDesignator  senderId )

inline

Parameters

senderId

GlobalObjectDesignator of the Sender entity.

References com.mak.vrlj.interaction.AcknowledgeInteraction.mySenderId.

String com.mak.vrlj.interaction.AcknowledgeInteraction.toString ( )

inline

References com.mak.vrlj.interaction.AcknowledgeInteraction.myAcknowledgeFlag, com.mak.vrlj.interaction.AcknowledgeInteraction.myReceiverId, com.mak.vrlj.interaction.AcknowledgeInteraction.myRequestId, com.mak.vrlj.interaction.AcknowledgeInteraction.myResponseFlag, and com.mak.vrlj.interaction.AcknowledgeInteraction.mySenderId.

Member Data Documentation

AcknowledgeFlag com.mak.vrlj.interaction.AcknowledgeInteraction.myAcknowledgeFlag = AcknowledgeFlag.EMPTY

private

Referenced by com.mak.vrlj.interaction.AcknowledgeInteraction.equals(), com.mak.vrlj.interaction.AcknowledgeInteraction.getAcknowledgeFlag(), com.mak.vrlj.interaction.AcknowledgeInteraction.hashCode(), com.mak.vrlj.interaction.AcknowledgeInteraction.setAcknowledgeFlag(), and com.mak.vrlj.interaction.AcknowledgeInteraction.toString().

GlobalObjectDesignator com.mak.vrlj.interaction.AcknowledgeInteraction.myReceiverId = new GlobalObjectDesignator("")

private

Referenced by com.mak.vrlj.interaction.AcknowledgeInteraction.equals(), com.mak.vrlj.interaction.AcknowledgeInteraction.getReceiverId(), com.mak.vrlj.interaction.AcknowledgeInteraction.hashCode(), com.mak.vrlj.interaction.AcknowledgeInteraction.setReceiverId(), and com.mak.vrlj.interaction.AcknowledgeInteraction.toString().

int com.mak.vrlj.interaction.AcknowledgeInteraction.myRequestId

private

Referenced by com.mak.vrlj.interaction.AcknowledgeInteraction.equals(), com.mak.vrlj.interaction.AcknowledgeInteraction.getRequestId(), com.mak.vrlj.interaction.AcknowledgeInteraction.hashCode(), com.mak.vrlj.interaction.AcknowledgeInteraction.setRequestId(), and com.mak.vrlj.interaction.AcknowledgeInteraction.toString().

ResponseFlag com.mak.vrlj.interaction.AcknowledgeInteraction.myResponseFlag = ResponseFlag.NOWAY

private

Referenced by com.mak.vrlj.interaction.AcknowledgeInteraction.equals(), com.mak.vrlj.interaction.AcknowledgeInteraction.getResponseFlag(), com.mak.vrlj.interaction.AcknowledgeInteraction.hashCode(), com.mak.vrlj.interaction.AcknowledgeInteraction.setResponseFlag(), and com.mak.vrlj.interaction.AcknowledgeInteraction.toString().

GlobalObjectDesignator com.mak.vrlj.interaction.AcknowledgeInteraction.mySenderId = new GlobalObjectDesignator("")

private

Referenced by com.mak.vrlj.interaction.AcknowledgeInteraction.equals(), com.mak.vrlj.interaction.AcknowledgeInteraction.getSenderId(), com.mak.vrlj.interaction.AcknowledgeInteraction.hashCode(), com.mak.vrlj.interaction.AcknowledgeInteraction.setSenderId(), and com.mak.vrlj.interaction.AcknowledgeInteraction.toString().

final String com.mak.vrlj.interaction.AcknowledgeInteraction.NAME = ":Acknowledge"

static

Interaction class name.

Referenced by com.mak.vrlj.interaction.AcknowledgeInteraction.addListener(), com.mak.vrlj.interaction.AcknowledgeInteraction.getInteractionName(), and com.mak.vrlj.interaction.AcknowledgeInteraction.removeListener().

---

The documentation for this class was generated from the following file:

• AcknowledgeInteraction.java