com.mak.vrlj.interaction.DataInteraction Class Reference

A Data interaction simply sends FixedData and VariableData between simulations. More...

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

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

Public Member Functions
boolean	equals (Object obj)
List< FixedData >	getFixedData ()
GlobalObjectDesignator	getReceiverId ()
long	getRequestId ()
GlobalObjectDesignator	getSenderId ()
List< VariableData >	getVariableData ()
int	hashCode ()
void	setFixedData (List< FixedData > fixedData)
void	setReceiverId (GlobalObjectDesignator receiverId)
void	setRequestId (long requestId)
void	setSenderId (GlobalObjectDesignator senderId)
void	setVariableData (List< VariableData > variableData)
String	toString ()
String	getInteractionName ()

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

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

Private Attributes
GlobalObjectDesignator	mySenderId = new GlobalObjectDesignator("")
GlobalObjectDesignator	myReceiverId = new GlobalObjectDesignator("")
long	myRequestId

Detailed Description

A Data interaction simply sends FixedData and VariableData between simulations.

Member Function Documentation

static InteractionListener<DataInteraction> com.mak.vrlj.interaction.DataInteraction.addListener ( ExerciseConnection  exConn, InteractionListener< DataInteraction >  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.DataInteraction.NAME.

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

inline

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

List<FixedData> com.mak.vrlj.interaction.DataInteraction.getFixedData ( )

inline

Returns

the FixedData in this interaction.

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

inlinevirtual

Implements com.mak.vrlj.interaction.Interaction.

References com.mak.vrlj.interaction.DataInteraction.NAME.

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

inline

Returns

GlobalObjectDesignator of the Receiver entity.

References com.mak.vrlj.interaction.DataInteraction.myReceiverId.

long com.mak.vrlj.interaction.DataInteraction.getRequestId ( )

inline

Returns

ID of the data request.

References com.mak.vrlj.interaction.DataInteraction.myRequestId.

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

inline

Returns

GlobalObjectDesignator of the Sending entity.

References com.mak.vrlj.interaction.DataInteraction.mySenderId.

List<VariableData> com.mak.vrlj.interaction.DataInteraction.getVariableData ( )

inline

Returns

the VariableData in this interaction.

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

inline

References com.mak.vrlj.interaction.DataInteraction.myReceiverId, com.mak.vrlj.interaction.DataInteraction.myRequestId, and com.mak.vrlj.interaction.DataInteraction.mySenderId.

static void com.mak.vrlj.interaction.DataInteraction.removeListener ( ExerciseConnection  exConn, InteractionListener< DataInteraction >  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.DataInteraction.NAME, and com.mak.vrlj.vl.ExerciseConnection.removeInteractionListener().

void com.mak.vrlj.interaction.DataInteraction.setFixedData ( List< FixedData >  fixedData )

inline

Parameters

fixedData

the list of FixedData to send.

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

inline

Parameters

ReceiverId

GlobalObjectDesignator of the Receivered entity.

References com.mak.vrlj.interaction.DataInteraction.myReceiverId.

void com.mak.vrlj.interaction.DataInteraction.setRequestId ( long  requestId )

inline

Parameters

requestId

id of the data request.

References com.mak.vrlj.interaction.DataInteraction.myRequestId.

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

inline

Parameters

SenderId

GlobalObjectDesignator of the Sender entity.

References com.mak.vrlj.interaction.DataInteraction.mySenderId.

void com.mak.vrlj.interaction.DataInteraction.setVariableData ( List< VariableData >  variableData )

inline

Parameters

variableData

the list of VariableData to send.

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

inline

References com.mak.vrlj.interaction.DataInteraction.myReceiverId, com.mak.vrlj.interaction.DataInteraction.myRequestId, and com.mak.vrlj.interaction.DataInteraction.mySenderId.

Member Data Documentation

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

private

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

long com.mak.vrlj.interaction.DataInteraction.myRequestId

private

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

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

private

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

final String com.mak.vrlj.interaction.DataInteraction.NAME = ":Data"

static

Interaction class name.

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

---

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

• DataInteraction.java