Class MinefieldQueryPdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.MinefieldFamilyPdu

edu.nps.moves.dis7.pdus.MinefieldQueryPdu

All Implemented Interfaces:

Marshaller, Serializable

public class MinefieldQueryPdu
extends MinefieldFamilyPdu
implements Serializable

5.10.3 Contains information about the requesting entity and the region and mine types of interest to the requesting entity.

See Also:

• IEEE Std 1278.1-2012, IEEE Standard for Distributed Interactive Simulation - Application Protocols
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ByteArrayOutputStream	byteArrayOutputStream	byteArrayOutputStream (baos) is used for marshal/unmarshal serialization
protected DataFilterRecord	dataFilter	data filter, 32 boolean fields
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected MinefieldIdentifier	minefieldID	Minefield ID provides a unique identifier
static final String	NAME	The name of this PDU type
protected byte	numberOfPerimeterPoints	Number of perimeter points for the minefield
protected byte	numberOfSensorTypes	Number of sensor types
protected byte	padding	zero-filled array of padding bits for byte alignment and consistent sizing of PDU data
protected EntityType	requestedMineType	Entity type of mine being requested
protected List<Vector2Float>	requestedPerimeterPoints	perimeter points of request
protected byte	requestID	request ID provides a unique identifier
protected EntityID	requestingEntityID	EID of entity making the request
protected List<MinefieldSensorType>	sensorTypes	Sensor types, each 16-bits long

Fields inherited from class edu.nps.moves.dis7.pdus.MinefieldFamilyPdu

FAMILY_NAME

Fields inherited from class edu.nps.moves.dis7.pdus.PduBase

pduStatus

Fields inherited from class edu.nps.moves.dis7.pdus.Pdu

exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp

Constructor Summary

Constructors

Constructor	Description
MinefieldQueryPdu()	Constructor creates and configures a new instance object

Method Summary

Modifier and Type	Method	Description
MinefieldQueryPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
MinefieldQueryPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
MinefieldQueryPdu	copyDataOutputStream()	copy method creates a deep copy of current object using DataOutputStream methods.
boolean	equals(Object obj)
boolean	equalsImpl(Object obj)	Compare all fields that contribute to the state, ignoring transient and static fields, for this and the supplied object
DataFilterRecord	getDataFilter()	Getter for dataFilter
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
MinefieldIdentifier	getMinefieldID()	Getter for minefieldID
byte	getPadding()	Getter for padding
EntityType	getRequestedMineType()	Getter for requestedMineType
List<Vector2Float>	getRequestedPerimeterPoints()	Getter for requestedPerimeterPoints
byte	getRequestID()	Getter for requestID
EntityID	getRequestingEntityID()	Getter for requestingEntityID
List<MinefieldSensorType>	getSensorTypes()	Getter for sensorTypes
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
MinefieldQueryPdu	setDataFilter(DataFilterRecord pDataFilter)	Setter for dataFilter
MinefieldQueryPdu	setMinefieldID(MinefieldIdentifier pMinefieldID)	Setter for minefieldID
MinefieldQueryPdu	setPadding(byte pPadding)	Setter for padding
MinefieldQueryPdu	setPadding(int pPadding)	Utility setter for padding
MinefieldQueryPdu	setRequestedMineType(EntityType pRequestedMineType)	Setter for requestedMineType
MinefieldQueryPdu	setRequestedPerimeterPoints(List<Vector2Float> pRequestedPerimeterPoints)	Setter for requestedPerimeterPoints
MinefieldQueryPdu	setRequestID(byte pRequestID)	Setter for requestID
MinefieldQueryPdu	setRequestID(int pRequestID)	Utility setter for requestID
MinefieldQueryPdu	setRequestingEntityID(EntityID pRequestingEntityID)	Setter for requestingEntityID
MinefieldQueryPdu	setSensorTypes(List<MinefieldSensorType> pSensorTypes)	Setter for sensorTypes
String	toString()
int	unmarshal(DataInputStream dis)	Deserializes an object from a DataInputStream.
int	unmarshal(ByteBuffer byteBuffer)	Unpacks a Pdu from the underlying data.

Methods inherited from class edu.nps.moves.dis7.pdus.PduBase

getPduStatus, setPduStatus

Methods inherited from class edu.nps.moves.dis7.pdus.Pdu

copyByPduFactory, getExerciseID, getLength, getPduType, getProtocolFamily, getProtocolVersion, getTimestamp, getTimestampSeconds, isAcknowledgeRPdu, isActionRequestPdu, isActionRequestRPdu, isActionResponsePdu, isActionResponseRPdu, isAggregateStatePdu, isAppearancePdu, isArealObjectStatePdu, isArticulatedPartsPdu, isAttributePdu, isCollisionElasticPdu, isCollisionPdu, isCommentPdu, isCommentRPdu, isCreateEntityPdu, isCreateEntityRPdu, isDataPdu, isDataQueryPdu, isDataQueryRPdu, isDataRPdu, isDesignatorPdu, isDetonationPdu, isDirectedEnergyFirePdu, isDistributedEmissionsRegenerationFamilyPdu, isElectromagneticEmissionPdu, isEntityDamageStatusPdu, isEntityInformationInteractionFamilyPdu, isEntityManagementFamilyPdu, isEntityStatePdu, isEntityStateUpdatePdu, isEnvironmentalProcessPdu, isEventReportPdu, isEventReportRPdu, isFirePdu, isGriddedDataPdu, isIFFPdu, isInformationOperationsActionPdu, isInformationOperationsFamilyPdu, isInformationOperationsReportPdu, isIntercomControlPdu, isIntercomSignalPdu, isIsGroupOfPdu, isIsPartOfPdu, isLEDetonationPdu, isLEFirePdu, isLinearObjectStatePdu, isLiveEntityDetonationPdu, isLiveEntityFirePdu, isLogisticsFamilyPdu, isMinefieldDataPdu, isMinefieldFamilyPdu, isMinefieldQueryPdu, isMinefieldResponseNACKPdu, isMinefieldStatePdu, isPointObjectStatePdu, isRadioCommunicationsFamilyPdu, isReceiverPdu, isRecordQueryRPdu, isRecordRPdu, isReliablePdu, isRemoveEntityPdu, isRemoveEntityRPdu, isRepairCompletePdu, isRepairResponsePdu, isResupplyCancelPdu, isResupplyOfferPdu, isResupplyReceivedPdu, isSEESPdu, isSetDataPdu, isSetDataRPdu, isSetRecordRPdu, isSignalPdu, isSimulationManagementFamilyPdu, isSimulationManagementWithReliabilityFamilyPdu, isStartResumePdu, isStartResumeRPdu, isStopFreezePdu, isStopFreezeRPdu, isSupplementalEmissionEntityStatePdu, isSyntheticEnvironmentFamilyPdu, isTransferOwnershipPdu, isTransmitterPdu, isTSPIPdu, isUnderwaterAcousticPdu, isWarfareFamilyPdu, marshal, occursAfter, occursBefore, occursSameTime, setExerciseID, setExerciseID, setLength, setLength, setPduType, setProtocolFamily, setProtocolVersion, setTimestamp, setTimestampSeconds

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NAME

public static final String NAME

The name of this PDU type

See Also:

• Constant Field Values

minefieldID

protected MinefieldIdentifier minefieldID

Minefield ID provides a unique identifier

requestingEntityID

protected EntityID requestingEntityID

EID of entity making the request

requestID

protected byte requestID

request ID provides a unique identifier

numberOfPerimeterPoints

protected byte numberOfPerimeterPoints

Number of perimeter points for the minefield

padding

protected byte padding

zero-filled array of padding bits for byte alignment and consistent sizing of PDU data

numberOfSensorTypes

protected byte numberOfSensorTypes

Number of sensor types

dataFilter

protected DataFilterRecord dataFilter

data filter, 32 boolean fields

requestedMineType

protected EntityType requestedMineType

Entity type of mine being requested

requestedPerimeterPoints

protected List<Vector2Float> requestedPerimeterPoints

perimeter points of request

sensorTypes

protected List<MinefieldSensorType> sensorTypes

Sensor types, each 16-bits long

byteArrayOutputStream

protected ByteArrayOutputStream byteArrayOutputStream

byteArrayOutputStream (baos) is used for marshal/unmarshal serialization

See Also:

• copyDataOutputStream()

dataOutputStream

protected DataOutputStream dataOutputStream

dataOutputStream (dos) is used for marshal/unmarshal serialization

See Also:

• copyDataOutputStream()

Constructor Details

MinefieldQueryPdu

public MinefieldQueryPdu()

Constructor creates and configures a new instance object

Method Details

copy

public MinefieldQueryPdu copy()

copy method creates a deep copy of current object using preferred marshalling method

Returns:

deep copy of PDU

copyByteBuffer

public MinefieldQueryPdu copyByteBuffer()

Creates a "deep copy" of current object using ByteBuffer methods.

Returns:

deep copy of PDU

copyDataOutputStream

public MinefieldQueryPdu copyDataOutputStream()

copy method creates a deep copy of current object using DataOutputStream methods.

Returns:

deep copy of PDU

getMarshalledSize

public int getMarshalledSize()

Returns size of this serialized (marshalled) object in bytes

Specified by:

getMarshalledSize in interface Marshaller

Overrides:

getMarshalledSize in class MinefieldFamilyPdu

Returns:

serialized size in bytes

See Also:

• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

setMinefieldID

public MinefieldQueryPdu setMinefieldID(MinefieldIdentifier pMinefieldID)

Setter for minefieldID

Parameters:

pMinefieldID - new value of interest

Returns:

same object to permit progressive setters

getMinefieldID

public MinefieldIdentifier getMinefieldID()

Getter for minefieldID

Returns:

value of interest

setRequestingEntityID

public MinefieldQueryPdu setRequestingEntityID(EntityID pRequestingEntityID)

Setter for requestingEntityID

Parameters:

pRequestingEntityID - new value of interest

Returns:

same object to permit progressive setters

getRequestingEntityID

public EntityID getRequestingEntityID()

Getter for requestingEntityID

Returns:

value of interest

setRequestID

public MinefieldQueryPdu setRequestID(byte pRequestID)

Setter for requestID

Parameters:

pRequestID - new value of interest

Returns:

same object to permit progressive setters

setRequestID

public MinefieldQueryPdu setRequestID(int pRequestID)

Utility setter for requestID

Parameters:

pRequestID - new value of interest

Returns:

same object to permit progressive setters

getRequestID

public byte getRequestID()

Getter for requestID

Returns:

value of interest

setPadding

public MinefieldQueryPdu setPadding(byte pPadding)

Setter for padding

Overrides:

setPadding in class PduBase

Parameters:

pPadding - new value of interest

Returns:

same object to permit progressive setters

setPadding

public MinefieldQueryPdu setPadding(int pPadding)

Utility setter for padding

Overrides:

setPadding in class PduBase

Parameters:

pPadding - new value of interest

Returns:

same object to permit progressive setters

getPadding

public byte getPadding()

Getter for padding

Overrides:

getPadding in class PduBase

Returns:

value of interest

setDataFilter

public MinefieldQueryPdu setDataFilter(DataFilterRecord pDataFilter)

Setter for dataFilter

Parameters:

pDataFilter - new value of interest

Returns:

same object to permit progressive setters

getDataFilter

public DataFilterRecord getDataFilter()

Getter for dataFilter

Returns:

value of interest

setRequestedMineType

public MinefieldQueryPdu setRequestedMineType(EntityType pRequestedMineType)

Setter for requestedMineType

Parameters:

pRequestedMineType - new value of interest

Returns:

same object to permit progressive setters

getRequestedMineType

public EntityType getRequestedMineType()

Getter for requestedMineType

Returns:

value of interest

setRequestedPerimeterPoints

public MinefieldQueryPdu setRequestedPerimeterPoints(List<Vector2Float> pRequestedPerimeterPoints)

Setter for requestedPerimeterPoints

Parameters:

pRequestedPerimeterPoints - new value of interest

Returns:

same object to permit progressive setters

getRequestedPerimeterPoints

public List<Vector2Float> getRequestedPerimeterPoints()

Getter for requestedPerimeterPoints

Returns:

value of interest

setSensorTypes

public MinefieldQueryPdu setSensorTypes(List<MinefieldSensorType> pSensorTypes)

Setter for sensorTypes

Parameters:

pSensorTypes - new value of interest

Returns:

same object to permit progressive setters

getSensorTypes

public List<MinefieldSensorType> getSensorTypes()

Getter for sensorTypes

Returns:

value of interest

marshal

public void marshal(DataOutputStream dos)
             throws Exception

Serializes an object to a DataOutputStream.

Specified by:

marshal in interface Marshaller

Overrides:

marshal in class MinefieldFamilyPdu

Parameters:

dos - the OutputStream

Throws:

Exception - if something goes wrong

See Also:

• DataOutputStream

unmarshal

public int unmarshal(DataInputStream dis)
              throws Exception

Deserializes an object from a DataInputStream.

Specified by:

unmarshal in interface Marshaller

Overrides:

unmarshal in class MinefieldFamilyPdu

Parameters:

dis - the InputStream

Returns:

marshalled serialized size in bytes

Throws:

Exception - if something goes wrong

See Also:

• DataInputStream
• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

marshal

public void marshal(ByteBuffer byteBuffer)
             throws Exception

Packs an object into the ByteBuffer.

Specified by:

marshal in interface Marshaller

Overrides:

marshal in class MinefieldFamilyPdu

Parameters:

byteBuffer - The ByteBuffer at the position to begin writing

Throws:

BufferOverflowException - if byteBuffer is too small

ReadOnlyBufferException - if byteBuffer is read only

Exception - ByteBuffer-generated exception

See Also:

• ByteBuffer

unmarshal

public int unmarshal(ByteBuffer byteBuffer)
              throws Exception

Unpacks a Pdu from the underlying data.

Specified by:

unmarshal in interface Marshaller

Overrides:

unmarshal in class MinefieldFamilyPdu

Parameters:

byteBuffer - The ByteBuffer at the position to begin reading

Returns:

marshalled serialized size in bytes

Throws:

BufferUnderflowException - if byteBuffer is too small

Exception - ByteBuffer-generated exception

See Also:

• ByteBuffer
• https://en.wikipedia.org/wiki/Marshalling_(computer_science)

equals

public boolean equals(Object obj)

Overrides:

equals in class MinefieldFamilyPdu

equalsImpl

public boolean equalsImpl(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 MinefieldFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class MinefieldFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase