edu.nps.moves.dismobile
Class SignalPdu

java.lang.Object
  extended by edu.nps.moves.dismobile.Pdu
      extended by edu.nps.moves.dismobile.RadioCommunicationsFamilyPdu
          extended by edu.nps.moves.dismobile.SignalPdu
All Implemented Interfaces:
java.io.Serializable

public class SignalPdu
extends RadioCommunicationsFamilyPdu
implements java.io.Serializable

Section 5.3.8.2. Detailed information about a radio transmitter. This PDU requires manually written code to complete. The encodingScheme field can be used in multiple ways, which requires hand-written code to finish. UNFINISHED Copyright (c) 2008-2010, MOVES Institute, Naval Postgraduate School. All rights reserved. This work is licensed under the BSD open source license, available at https://www.movesinstitute.org/licenses/bsd.html

Author:
DMcG
See Also:
Serialized Form

Field Summary
protected  java.util.List<OneByteChunk> data
          list of eight bit values
protected  short dataLength
          length od data
protected  int encodingScheme
          encoding scheme used, and enumeration
protected  long sampleRate
          sample rate
protected  short samples
          number of samples
protected  int tdlType
          tdl type
 
Fields inherited from class edu.nps.moves.dismobile.RadioCommunicationsFamilyPdu
entityId, radioId
 
Fields inherited from class edu.nps.moves.dismobile.Pdu
exerciseID, padding, pduLength, pduType, protocolFamily, protocolVersion, timestamp
 
Constructor Summary
SignalPdu()
          Constructor
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 boolean equalsImpl(java.lang.Object obj)
          Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object
 java.util.List<OneByteChunk> getData()
           
 short getDataLength()
           
 int getEncodingScheme()
           
 int getMarshalledSize()
           
 long getSampleRate()
           
 short getSamples()
           
 int getTdlType()
           
 void marshal(java.nio.ByteBuffer buff)
          Packs a Pdu into the ByteBuffer.
 void marshal(java.io.DataOutputStream dos)
           
 void setData(java.util.List<OneByteChunk> pData)
           
 void setDataLength(short pDataLength)
          Note that setting this value will not change the marshalled value.
 void setEncodingScheme(int pEncodingScheme)
           
 void setSampleRate(long pSampleRate)
           
 void setSamples(short pSamples)
           
 void setTdlType(int pTdlType)
           
 void unmarshal(java.nio.ByteBuffer buff)
          Unpacks a Pdu from the underlying data.
 void unmarshal(java.io.DataInputStream dis)
           
 
Methods inherited from class edu.nps.moves.dismobile.RadioCommunicationsFamilyPdu
getEntityId, getRadioId, setEntityId, setRadioId
 
Methods inherited from class edu.nps.moves.dismobile.Pdu
getExerciseID, getLength, getPadding, getPduLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, marshal, marshalWithDisAbsoluteTimestamp, marshalWithDisAbsoluteTimestamp, marshalWithDisRelativeTimestamp, marshalWithDisRelativeTimestamp, marshalWithNpsTimestamp, marshalWithNpsTimestamp, marshalWithUnixTimestamp, marshalWithUnixTimestamp, readUnsignedInt, readUnsignedInt, setExerciseID, setPadding, setPduLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

encodingScheme

protected int encodingScheme
encoding scheme used, and enumeration


tdlType

protected int tdlType
tdl type


sampleRate

protected long sampleRate
sample rate


dataLength

protected short dataLength
length od data


samples

protected short samples
number of samples


data

protected java.util.List<OneByteChunk> data
list of eight bit values

Constructor Detail

SignalPdu

public SignalPdu()
Constructor

Method Detail

getMarshalledSize

public int getMarshalledSize()
Overrides:
getMarshalledSize in class RadioCommunicationsFamilyPdu

setEncodingScheme

public void setEncodingScheme(int pEncodingScheme)

getEncodingScheme

public int getEncodingScheme()

setTdlType

public void setTdlType(int pTdlType)

getTdlType

public int getTdlType()

setSampleRate

public void setSampleRate(long pSampleRate)

getSampleRate

public long getSampleRate()

getDataLength

public short getDataLength()

setDataLength

public void setDataLength(short pDataLength)
Note that setting this value will not change the marshalled value. The list whose length this describes is used for that purpose. The getdataLength method will also be based on the actual list length rather than this value. The method is simply here for java bean completeness.


setSamples

public void setSamples(short pSamples)

getSamples

public short getSamples()

setData

public void setData(java.util.List<OneByteChunk> pData)

getData

public java.util.List<OneByteChunk> getData()

marshal

public void marshal(java.io.DataOutputStream dos)
Overrides:
marshal in class RadioCommunicationsFamilyPdu

unmarshal

public void unmarshal(java.io.DataInputStream dis)
Overrides:
unmarshal in class RadioCommunicationsFamilyPdu

marshal

public void marshal(java.nio.ByteBuffer buff)
Packs a Pdu into the ByteBuffer.

Overrides:
marshal in class RadioCommunicationsFamilyPdu
Parameters:
buff - The ByteBuffer at the position to begin writing
Throws:
java.nio.BufferOverflowException - if buff is too small
java.nio.ReadOnlyBufferException - if buff is read only
Since:
??
See Also:
ByteBuffer

unmarshal

public void unmarshal(java.nio.ByteBuffer buff)
Unpacks a Pdu from the underlying data.

Overrides:
unmarshal in class RadioCommunicationsFamilyPdu
Parameters:
buff - The ByteBuffer at the position to begin reading
Throws:
java.nio.BufferUnderflowException - if buff is too small
Since:
??
See Also:
ByteBuffer

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class RadioCommunicationsFamilyPdu

equalsImpl

public boolean equalsImpl(java.lang.Object obj)
Description copied from class: Pdu
Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object

Overrides:
equalsImpl in class RadioCommunicationsFamilyPdu
Parameters:
obj - the object to compare to
Returns:
true if the objects are equal, false otherwise.