com.mak.vrlj.interaction.SignalInteraction Class Reference

Signal message between entities. More...

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

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

Public Member Functions
boolean	equals (Object obj)
byte[]	getData ()
EncodingClass	getEncodingClass ()
EncodingType	getEncodingType ()
GlobalObjectDesignator	getEntityId ()
int	getNumSamples ()
short	getRadioId ()
int	getSampleRate ()
TDLType	getTDLType ()
int	hashCode ()
void	setData (byte[] data)
void	setEncodingClass (EncodingClass ec)
void	setEncodingType (EncodingType et)
void	setEntityId (GlobalObjectDesignator entityId)
void	setNumSamples (int theNumSamples)
void	setRadioId (short ri)
void	setSampleRate (int sr)
void	setTDLType (TDLType tdl)
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 < SignalInteraction >	addListener (ExerciseConnection exConn, InteractionListener< SignalInteraction > listener)
	Subscribe for callbacks when new interactions are received over the specified ExerciseConnection. More...
static void	removeListener (ExerciseConnection exConn, InteractionListener< SignalInteraction > listener)
	Remove a subscription for interactions callbacks on an ExerciseConnection. More...

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

Private Attributes
GlobalObjectDesignator	myEntityId = new GlobalObjectDesignator("")
short	myRadioId
EncodingClass	myEncodingClass = EncodingClass.ENCODED_AUDIO
EncodingType	myEncodingType = EncodingType.EIGHTBIT_MU_LAW
TDLType	myTDLType = TDLType.OTHER
int	mySampleRate
int	myNumSamples
byte[]	myData = new byte[0]

Detailed Description

Signal message between entities.

Member Function Documentation

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

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

inline

References com.mak.vrlj.object.GlobalObjectDesignator.equals(), com.mak.vrlj.interaction.SignalInteraction.myData, com.mak.vrlj.interaction.SignalInteraction.myEncodingClass, com.mak.vrlj.interaction.SignalInteraction.myEncodingType, com.mak.vrlj.interaction.SignalInteraction.myEntityId, com.mak.vrlj.interaction.SignalInteraction.myRadioId, com.mak.vrlj.interaction.SignalInteraction.mySampleRate, and com.mak.vrlj.interaction.SignalInteraction.myTDLType.

byte [] com.mak.vrlj.interaction.SignalInteraction.getData ( )

inline

Returns

the value for the data payload

References com.mak.vrlj.interaction.SignalInteraction.myData.

EncodingClass com.mak.vrlj.interaction.SignalInteraction.getEncodingClass ( )

inline

Returns

EncodingClass

References com.mak.vrlj.interaction.SignalInteraction.myEncodingClass.

EncodingType com.mak.vrlj.interaction.SignalInteraction.getEncodingType ( )

inline

Returns

EncodingType

References com.mak.vrlj.interaction.SignalInteraction.myEncodingType.

GlobalObjectDesignator com.mak.vrlj.interaction.SignalInteraction.getEntityId ( )

inline

Returns

GlobalObjectDesignator of the entity.

References com.mak.vrlj.interaction.SignalInteraction.myEntityId.

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

inlinevirtual

Implements com.mak.vrlj.interaction.Interaction.

References com.mak.vrlj.interaction.SignalInteraction.NAME.

int com.mak.vrlj.interaction.SignalInteraction.getNumSamples ( )

inline

Returns

the myNumSamples

References com.mak.vrlj.interaction.SignalInteraction.myNumSamples.

short com.mak.vrlj.interaction.SignalInteraction.getRadioId ( )

inline

Returns

the Radio Identifier.

References com.mak.vrlj.interaction.SignalInteraction.myRadioId.

int com.mak.vrlj.interaction.SignalInteraction.getSampleRate ( )

inline

Returns

the Sample Rate.

References com.mak.vrlj.interaction.SignalInteraction.mySampleRate.

TDLType com.mak.vrlj.interaction.SignalInteraction.getTDLType ( )

inline

Returns

TDLType

References com.mak.vrlj.interaction.SignalInteraction.myTDLType.

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

inline

References com.mak.vrlj.interaction.SignalInteraction.myData, com.mak.vrlj.interaction.SignalInteraction.myEncodingClass, com.mak.vrlj.interaction.SignalInteraction.myEncodingType, com.mak.vrlj.interaction.SignalInteraction.myEntityId, com.mak.vrlj.interaction.SignalInteraction.myRadioId, com.mak.vrlj.interaction.SignalInteraction.mySampleRate, and com.mak.vrlj.interaction.SignalInteraction.myTDLType.

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

void com.mak.vrlj.interaction.SignalInteraction.setData ( byte[]  data )

inline

Parameters

Data

References com.mak.vrlj.interaction.SignalInteraction.myData.

void com.mak.vrlj.interaction.SignalInteraction.setEncodingClass ( EncodingClass  ec )

inline

Parameters

EncodingClass

EncodingClass

References com.mak.vrlj.interaction.SignalInteraction.myEncodingClass.

void com.mak.vrlj.interaction.SignalInteraction.setEncodingType ( EncodingType  et )

inline

Parameters

EncodingType

EncodingType

References com.mak.vrlj.interaction.SignalInteraction.myEncodingType.

void com.mak.vrlj.interaction.SignalInteraction.setEntityId ( GlobalObjectDesignator  entityId )

inline

Parameters

EntityId

GlobalObjectDesignator of the entity.

References com.mak.vrlj.interaction.SignalInteraction.myEntityId.

void com.mak.vrlj.interaction.SignalInteraction.setNumSamples ( int  theNumSamples )

inline

Parameters

theNumSamples

the myNumSamples to set

References com.mak.vrlj.interaction.SignalInteraction.myNumSamples.

void com.mak.vrlj.interaction.SignalInteraction.setRadioId ( short  ri )

inline

Parameters

radioId

References com.mak.vrlj.interaction.SignalInteraction.myRadioId.

void com.mak.vrlj.interaction.SignalInteraction.setSampleRate ( int  sr )

inline

Parameters

SampleRate

References com.mak.vrlj.interaction.SignalInteraction.mySampleRate.

void com.mak.vrlj.interaction.SignalInteraction.setTDLType ( TDLType  tdl )

inline

Parameters

TDLType

TDLType

References com.mak.vrlj.interaction.SignalInteraction.myTDLType.

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

inline

References com.mak.vrlj.interaction.SignalInteraction.myData, com.mak.vrlj.interaction.SignalInteraction.myEncodingClass, com.mak.vrlj.interaction.SignalInteraction.myEncodingType, com.mak.vrlj.interaction.SignalInteraction.myEntityId, com.mak.vrlj.interaction.SignalInteraction.myRadioId, com.mak.vrlj.interaction.SignalInteraction.mySampleRate, and com.mak.vrlj.interaction.SignalInteraction.myTDLType.

Member Data Documentation

byte [] com.mak.vrlj.interaction.SignalInteraction.myData = new byte[0]

private

Referenced by com.mak.vrlj.interaction.SignalInteraction.equals(), com.mak.vrlj.interaction.SignalInteraction.getData(), com.mak.vrlj.interaction.SignalInteraction.hashCode(), com.mak.vrlj.interaction.SignalInteraction.setData(), and com.mak.vrlj.interaction.SignalInteraction.toString().

EncodingClass com.mak.vrlj.interaction.SignalInteraction.myEncodingClass = EncodingClass.ENCODED_AUDIO

private

Referenced by com.mak.vrlj.interaction.SignalInteraction.equals(), com.mak.vrlj.interaction.SignalInteraction.getEncodingClass(), com.mak.vrlj.interaction.SignalInteraction.hashCode(), com.mak.vrlj.interaction.SignalInteraction.setEncodingClass(), and com.mak.vrlj.interaction.SignalInteraction.toString().

EncodingType com.mak.vrlj.interaction.SignalInteraction.myEncodingType = EncodingType.EIGHTBIT_MU_LAW

private

Referenced by com.mak.vrlj.interaction.SignalInteraction.equals(), com.mak.vrlj.interaction.SignalInteraction.getEncodingType(), com.mak.vrlj.interaction.SignalInteraction.hashCode(), com.mak.vrlj.interaction.SignalInteraction.setEncodingType(), and com.mak.vrlj.interaction.SignalInteraction.toString().

GlobalObjectDesignator com.mak.vrlj.interaction.SignalInteraction.myEntityId = new GlobalObjectDesignator("")

private

Referenced by com.mak.vrlj.interaction.SignalInteraction.equals(), com.mak.vrlj.interaction.SignalInteraction.getEntityId(), com.mak.vrlj.interaction.SignalInteraction.hashCode(), com.mak.vrlj.interaction.SignalInteraction.setEntityId(), and com.mak.vrlj.interaction.SignalInteraction.toString().

int com.mak.vrlj.interaction.SignalInteraction.myNumSamples

private

Referenced by com.mak.vrlj.interaction.SignalInteraction.getNumSamples(), and com.mak.vrlj.interaction.SignalInteraction.setNumSamples().

short com.mak.vrlj.interaction.SignalInteraction.myRadioId

private

Referenced by com.mak.vrlj.interaction.SignalInteraction.equals(), com.mak.vrlj.interaction.SignalInteraction.getRadioId(), com.mak.vrlj.interaction.SignalInteraction.hashCode(), com.mak.vrlj.interaction.SignalInteraction.setRadioId(), and com.mak.vrlj.interaction.SignalInteraction.toString().

int com.mak.vrlj.interaction.SignalInteraction.mySampleRate

private

Referenced by com.mak.vrlj.interaction.SignalInteraction.equals(), com.mak.vrlj.interaction.SignalInteraction.getSampleRate(), com.mak.vrlj.interaction.SignalInteraction.hashCode(), com.mak.vrlj.interaction.SignalInteraction.setSampleRate(), and com.mak.vrlj.interaction.SignalInteraction.toString().

TDLType com.mak.vrlj.interaction.SignalInteraction.myTDLType = TDLType.OTHER

private

Referenced by com.mak.vrlj.interaction.SignalInteraction.equals(), com.mak.vrlj.interaction.SignalInteraction.getTDLType(), com.mak.vrlj.interaction.SignalInteraction.hashCode(), com.mak.vrlj.interaction.SignalInteraction.setTDLType(), and com.mak.vrlj.interaction.SignalInteraction.toString().

final String com.mak.vrlj.interaction.SignalInteraction.NAME = ":Signal"

static

Interaction class name.

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

---

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

• SignalInteraction.java