edu.nps.moves.dismobile
Class DataQueryPdu

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

public class DataQueryPdu
extends SimulationManagementFamilyPdu
implements java.io.Serializable

Section 5.3.6.8. Request for data from an entity. COMPLETE 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<FixedDatum> fixedDatums
          variable length list of fixed datums
protected  long numberOfFixedDatumRecords
          Number of fixed datum records
protected  long numberOfVariableDatumRecords
          Number of variable datum records
protected  long requestID
          ID of request
protected  long timeInterval
          time issues between issues of Data PDUs.
protected  java.util.List<VariableDatum> variableDatums
          variable length list of variable length datums
 
Fields inherited from class edu.nps.moves.dismobile.SimulationManagementFamilyPdu
originatingEntityID, receivingEntityID
 
Fields inherited from class edu.nps.moves.dismobile.Pdu
exerciseID, padding, pduLength, pduType, protocolFamily, protocolVersion, timestamp
 
Constructor Summary
DataQueryPdu()
          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<FixedDatum> getFixedDatums()
           
 int getMarshalledSize()
           
 long getNumberOfFixedDatumRecords()
           
 long getNumberOfVariableDatumRecords()
           
 long getRequestID()
           
 long getTimeInterval()
           
 java.util.List<VariableDatum> getVariableDatums()
           
 void marshal(java.nio.ByteBuffer buff)
          Packs a Pdu into the ByteBuffer.
 void marshal(java.io.DataOutputStream dos)
           
 void setFixedDatums(java.util.List<FixedDatum> pFixedDatums)
           
 void setNumberOfFixedDatumRecords(long pNumberOfFixedDatumRecords)
          Note that setting this value will not change the marshalled value.
 void setNumberOfVariableDatumRecords(long pNumberOfVariableDatumRecords)
          Note that setting this value will not change the marshalled value.
 void setRequestID(long pRequestID)
           
 void setTimeInterval(long pTimeInterval)
           
 void setVariableDatums(java.util.List<VariableDatum> pVariableDatums)
           
 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.SimulationManagementFamilyPdu
getOriginatingEntityID, getReceivingEntityID, setOriginatingEntityID, setReceivingEntityID
 
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

requestID

protected long requestID
ID of request


timeInterval

protected long timeInterval
time issues between issues of Data PDUs. Zero means send once only.


numberOfFixedDatumRecords

protected long numberOfFixedDatumRecords
Number of fixed datum records


numberOfVariableDatumRecords

protected long numberOfVariableDatumRecords
Number of variable datum records


fixedDatums

protected java.util.List<FixedDatum> fixedDatums
variable length list of fixed datums


variableDatums

protected java.util.List<VariableDatum> variableDatums
variable length list of variable length datums

Constructor Detail

DataQueryPdu

public DataQueryPdu()
Constructor

Method Detail

getMarshalledSize

public int getMarshalledSize()
Overrides:
getMarshalledSize in class SimulationManagementFamilyPdu

setRequestID

public void setRequestID(long pRequestID)

getRequestID

public long getRequestID()

setTimeInterval

public void setTimeInterval(long pTimeInterval)

getTimeInterval

public long getTimeInterval()

getNumberOfFixedDatumRecords

public long getNumberOfFixedDatumRecords()

setNumberOfFixedDatumRecords

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


getNumberOfVariableDatumRecords

public long getNumberOfVariableDatumRecords()

setNumberOfVariableDatumRecords

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


setFixedDatums

public void setFixedDatums(java.util.List<FixedDatum> pFixedDatums)

getFixedDatums

public java.util.List<FixedDatum> getFixedDatums()

setVariableDatums

public void setVariableDatums(java.util.List<VariableDatum> pVariableDatums)

getVariableDatums

public java.util.List<VariableDatum> getVariableDatums()

marshal

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

unmarshal

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

marshal

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

Overrides:
marshal in class SimulationManagementFamilyPdu
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 SimulationManagementFamilyPdu
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 SimulationManagementFamilyPdu

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 SimulationManagementFamilyPdu
Parameters:
obj - the object to compare to
Returns:
true if the objects are equal, false otherwise.