edu.nps.moves.dis7mobile
Class PduSuperclass

java.lang.Object
  edu.nps.moves.dis7mobile.PduSuperclass

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

LiveEntityPdu, Pdu

public class PduSuperclass
extends java.lang.Object
implements java.io.Serializable

The superclass for all PDUs, including classic and Live Entity (LE) PDUs. This incorporates the PduHeader record, section 7.2.2 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 short	exerciseID Exercise ID
protected int	length Length, in bytes, of the PDU
protected short	pduType Type of pdu, unique for each PDU class
protected short	protocolFamily value that refers to the protocol family, eg SimulationManagement, et
protected short	protocolVersion The version of the protocol.
protected long	timestamp Timestamp value

Constructor Summary

PduSuperclass()
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
short	getExerciseID()
int	getLength()
int	getMarshalledSize()
short	getPduType()
short	getProtocolFamily()
short	getProtocolVersion()
long	getTimestamp()
void	marshal(java.nio.ByteBuffer buff) Packs a Pdu into the ByteBuffer.
void	marshal(java.io.DataOutputStream dos)
void	setExerciseID(short pExerciseID)
void	setLength(int pLength)
void	setPduType(short pPduType)
void	setProtocolFamily(short pProtocolFamily)
void	setProtocolVersion(short pProtocolVersion)
void	setTimestamp(long pTimestamp)
void	unmarshal(java.nio.ByteBuffer buff) Unpacks a Pdu from the underlying data.
void	unmarshal(java.io.DataInputStream dis)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

protocolVersion

protected short protocolVersion

The version of the protocol. 5=DIS-1995, 6=DIS-1998, 7=DIS-2009.

exerciseID

protected short exerciseID

Exercise ID

pduType

protected short pduType

Type of pdu, unique for each PDU class

protocolFamily

protected short protocolFamily

value that refers to the protocol family, eg SimulationManagement, et

timestamp

protected long timestamp

Timestamp value

length

protected int length

Length, in bytes, of the PDU

Constructor Detail

PduSuperclass

public PduSuperclass()

Constructor

Method Detail

getMarshalledSize

public int getMarshalledSize()

setProtocolVersion

public void setProtocolVersion(short pProtocolVersion)

getProtocolVersion

public short getProtocolVersion()

setExerciseID

public void setExerciseID(short pExerciseID)

getExerciseID

public short getExerciseID()

setPduType

public void setPduType(short pPduType)

getPduType

public short getPduType()

setProtocolFamily

public void setProtocolFamily(short pProtocolFamily)

getProtocolFamily

public short getProtocolFamily()

setTimestamp

public void setTimestamp(long pTimestamp)

getTimestamp

public long getTimestamp()

setLength

public void setLength(int pLength)

getLength

public int getLength()

marshal

public void marshal(java.io.DataOutputStream dos)

unmarshal

public void unmarshal(java.io.DataInputStream dis)

marshal

public void marshal(java.nio.ByteBuffer buff)

Packs a Pdu into the ByteBuffer.

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.

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 java.lang.Object

equalsImpl

public 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

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.