edu.nps.moves.dis7mobile
Class StartResumePdu

java.lang.Object
  extended by edu.nps.moves.dis7mobile.PduSuperclass
      extended by edu.nps.moves.dis7mobile.Pdu
          extended by edu.nps.moves.dis7mobile.SimulationManagementFamilyPdu
              extended by edu.nps.moves.dis7mobile.StartResumePdu
All Implemented Interfaces:
java.io.Serializable

public class StartResumePdu
extends SimulationManagementFamilyPdu
implements java.io.Serializable

Section 7.5.4. Start or resume an exercise. 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  EntityID originatingID
          Identifier for originating entity(or simulation)
protected  ClockTime realWorldTime
          This field shall specify the real-world time (UTC) at which the entity is to start/resume in the exercise.
protected  EntityID receivingID
          Identifier for the receiving entity(or simulation)
protected  long requestID
          Identifier for the specific and unique start/resume request
protected  ClockTime simulationTime
          The reference time within a simulation exercise.
 
Fields inherited from class edu.nps.moves.dis7mobile.SimulationManagementFamilyPdu
originatingEntityID, receivingEntityID
 
Fields inherited from class edu.nps.moves.dis7mobile.Pdu
padding, pduStatus
 
Fields inherited from class edu.nps.moves.dis7mobile.PduSuperclass
exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp
 
Constructor Summary
StartResumePdu()
          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
 int getMarshalledSize()
           
 EntityID getOriginatingID()
           
 ClockTime getRealWorldTime()
           
 EntityID getReceivingID()
           
 long getRequestID()
           
 ClockTime getSimulationTime()
           
 void marshal(java.nio.ByteBuffer buff)
          Packs a Pdu into the ByteBuffer.
 void marshal(java.io.DataOutputStream dos)
           
 void setOriginatingID(EntityID pOriginatingID)
           
 void setRealWorldTime(ClockTime pRealWorldTime)
           
 void setReceivingID(EntityID pReceivingID)
           
 void setRequestID(long pRequestID)
           
 void setSimulationTime(ClockTime pSimulationTime)
           
 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.dis7mobile.SimulationManagementFamilyPdu
getOriginatingEntityID, getReceivingEntityID, setOriginatingEntityID, setReceivingEntityID
 
Methods inherited from class edu.nps.moves.dis7mobile.Pdu
getPadding, getPduStatus, marshal, setPadding, setPduStatus
 
Methods inherited from class edu.nps.moves.dis7mobile.PduSuperclass
getExerciseID, getLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, setExerciseID, setLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

originatingID

protected EntityID originatingID
Identifier for originating entity(or simulation)


receivingID

protected EntityID receivingID
Identifier for the receiving entity(or simulation)


realWorldTime

protected ClockTime realWorldTime
This field shall specify the real-world time (UTC) at which the entity is to start/resume in the exercise. This information shall be used by the participating simulation applications to start/resume an exercise synchronously. This field shall be represented by a Clock Time record (see 6.2.16).


simulationTime

protected ClockTime simulationTime
The reference time within a simulation exercise. This time is established ahead of time by simulation management and is common to all participants in a particular exercise. Simulation time may be either Absolute Time or Relative Time. This field shall be represented by a Clock Time record (see 6.2.16)


requestID

protected long requestID
Identifier for the specific and unique start/resume request

Constructor Detail

StartResumePdu

public StartResumePdu()
Constructor

Method Detail

getMarshalledSize

public int getMarshalledSize()
Overrides:
getMarshalledSize in class SimulationManagementFamilyPdu

setOriginatingID

public void setOriginatingID(EntityID pOriginatingID)

getOriginatingID

public EntityID getOriginatingID()

setReceivingID

public void setReceivingID(EntityID pReceivingID)

getReceivingID

public EntityID getReceivingID()

setRealWorldTime

public void setRealWorldTime(ClockTime pRealWorldTime)

getRealWorldTime

public ClockTime getRealWorldTime()

setSimulationTime

public void setSimulationTime(ClockTime pSimulationTime)

getSimulationTime

public ClockTime getSimulationTime()

setRequestID

public void setRequestID(long pRequestID)

getRequestID

public long getRequestID()

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: PduSuperclass
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.