Class IFFPdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.DistributedEmissionsRegenerationFamilyPdu

edu.nps.moves.dis7.pdus.IFFPdu

All Implemented Interfaces:

Marshaller, Serializable

Direct Known Subclasses:

IdentificationFriendOrFoePdu

public class IFFPdu
extends DistributedEmissionsRegenerationFamilyPdu
implements Serializable

7.6.5.1 Information about military and civilian interrogators, transponders, and specific other electronic systems. See 5.7.6

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 DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected EntityID	emittingEntityId	ID of the entity that is the source of the emissions.
protected EventIdentifier	eventID	Number generated by the issuing simulation to associate realted events.
protected FundamentalOperationalData	fundamentalParameters	Fundamental parameters.
protected IFFPduLayer2Data	iFFPduLayer2Data	IFF pdu layer 2 data
protected IFFPduLayer3InterrogatorFormatData	iFFPduLayer3InterrogatorFormatData	IFF pdu layer 3 interrogator format data
protected IFFPduLayer3TransponderFormatData	iFFPduLayer3TransponderFormatData	IFF pdu layer 3 transponder format data
protected IFFPduLayer4InterrogatorFormatData	iFFPduLayer4InterrogatorFormatData	IFF pdu layer 4 interrogator format data
protected IFFPduLayer4TransponderFormatData	iFFPduLayer4TransponderFormatData	IFF pdu layer 4 transponder format data
protected IFFPduLayer5Data	iFFPduLayer5Data	IFF pdu layer 5 data communications
protected Vector3Float	location	Location wrt entity.
static final String	NAME	The name of this PDU type
protected byte	systemDesignator	Part of Layer 1 basic system data 7.6.5.2.
protected SystemIdentifier	systemID	System ID information.
protected byte	systemSpecificData	Part of Layer 1 basic system data 7.6.5.2.

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

FAMILY_NAME

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

padding, pduStatus

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

exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
IFFPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
IFFPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
IFFPdu	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
EntityID	getEmittingEntityId()	Getter for emittingEntityId
EventIdentifier	getEventID()	Getter for eventID
FundamentalOperationalData	getFundamentalParameters()	Getter for fundamentalParameters
IFFPduLayer2Data	getIFFPduLayer2Data()	Getter for iFFPduLayer2Data
IFFPduLayer3InterrogatorFormatData	getIFFPduLayer3InterrogatorFormatData()	Getter for iFFPduLayer3InterrogatorFormatData
IFFPduLayer3TransponderFormatData	getIFFPduLayer3TransponderFormatData()	Getter for iFFPduLayer3TransponderFormatData
IFFPduLayer4InterrogatorFormatData	getIFFPduLayer4InterrogatorFormatData()	Getter for iFFPduLayer4InterrogatorFormatData
IFFPduLayer4TransponderFormatData	getIFFPduLayer4TransponderFormatData()	Getter for iFFPduLayer4TransponderFormatData
IFFPduLayer5Data	getIFFPduLayer5Data()	Getter for iFFPduLayer5Data
Vector3Float	getLocation()	Getter for location
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
byte	getSystemDesignator()	Getter for systemDesignator
SystemIdentifier	getSystemID()	Getter for systemID
byte	getSystemSpecificData()	Getter for systemSpecificData
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
IFFPdu	setEmittingEntityId(EntityID pEmittingEntityId)	Setter for emittingEntityId
IFFPdu	setEventID(EventIdentifier pEventID)	Setter for eventID
IFFPdu	setFundamentalParameters(FundamentalOperationalData pFundamentalParameters)	Setter for fundamentalParameters
IFFPdu	setIFFPduLayer2Data(IFFPduLayer2Data pIFFPduLayer2Data)	Setter for iFFPduLayer2Data
IFFPdu	setIFFPduLayer3InterrogatorFormatData(IFFPduLayer3InterrogatorFormatData pIFFPduLayer3InterrogatorFormatData)	Setter for iFFPduLayer3InterrogatorFormatData
IFFPdu	setIFFPduLayer3TransponderFormatData(IFFPduLayer3TransponderFormatData pIFFPduLayer3TransponderFormatData)	Setter for iFFPduLayer3TransponderFormatData
IFFPdu	setIFFPduLayer4InterrogatorFormatData(IFFPduLayer4InterrogatorFormatData pIFFPduLayer4InterrogatorFormatData)	Setter for iFFPduLayer4InterrogatorFormatData
IFFPdu	setIFFPduLayer4TransponderFormatData(IFFPduLayer4TransponderFormatData pIFFPduLayer4TransponderFormatData)	Setter for iFFPduLayer4TransponderFormatData
IFFPdu	setIFFPduLayer5Data(IFFPduLayer5Data pIFFPduLayer5Data)	Setter for iFFPduLayer5Data
IFFPdu	setLocation(Vector3Float pLocation)	Setter for location
IFFPdu	setSystemDesignator(byte pSystemDesignator)	Setter for systemDesignator
IFFPdu	setSystemDesignator(int pSystemDesignator)	Utility setter for systemDesignator
IFFPdu	setSystemID(SystemIdentifier pSystemID)	Setter for systemID
IFFPdu	setSystemSpecificData(byte pSystemSpecificData)	Setter for systemSpecificData
IFFPdu	setSystemSpecificData(int pSystemSpecificData)	Utility setter for systemSpecificData
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

getPadding, getPduStatus, setPadding, setPadding, 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

emittingEntityId

protected EntityID emittingEntityId

ID of the entity that is the source of the emissions. Part of Layer 1 basic system data 7.6.5.2.

eventID

protected EventIdentifier eventID

Number generated by the issuing simulation to associate realted events. Part of Layer 1 basic system data 7.6.5.2.

location

protected Vector3Float location

Location wrt entity. There is some ambiguity in the standard here, but this is the order it is listed in the table. Part of Layer 1 basic system data 7.6.5.2.

systemID

protected SystemIdentifier systemID

System ID information. Part of Layer 1 basic system data 7.6.5.2.

systemDesignator

protected byte systemDesignator

Part of Layer 1 basic system data 7.6.5.2.

systemSpecificData

protected byte systemSpecificData

Part of Layer 1 basic system data 7.6.5.2.

fundamentalParameters

protected FundamentalOperationalData fundamentalParameters

Fundamental parameters. Part of Layer 1 basic system data 7.6.5.2.

iFFPduLayer2Data

protected IFFPduLayer2Data iFFPduLayer2Data

IFF pdu layer 2 data

iFFPduLayer3TransponderFormatData

protected IFFPduLayer3TransponderFormatData iFFPduLayer3TransponderFormatData

IFF pdu layer 3 transponder format data

iFFPduLayer3InterrogatorFormatData

protected IFFPduLayer3InterrogatorFormatData iFFPduLayer3InterrogatorFormatData

IFF pdu layer 3 interrogator format data

iFFPduLayer4InterrogatorFormatData

protected IFFPduLayer4InterrogatorFormatData iFFPduLayer4InterrogatorFormatData

IFF pdu layer 4 interrogator format data

iFFPduLayer4TransponderFormatData

protected IFFPduLayer4TransponderFormatData iFFPduLayer4TransponderFormatData

IFF pdu layer 4 transponder format data

iFFPduLayer5Data

protected IFFPduLayer5Data iFFPduLayer5Data

IFF pdu layer 5 data communications

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

IFFPdu

public IFFPdu()

Constructor creates and configures a new instance object

Method Details

copy

public IFFPdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public IFFPdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public IFFPdu 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 DistributedEmissionsRegenerationFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setEmittingEntityId

public IFFPdu setEmittingEntityId(EntityID pEmittingEntityId)

Setter for emittingEntityId

Parameters:

pEmittingEntityId - new value of interest

Returns:

same object to permit progressive setters

getEmittingEntityId

public EntityID getEmittingEntityId()

Getter for emittingEntityId

Returns:

value of interest

setEventID

public IFFPdu setEventID(EventIdentifier pEventID)

Setter for eventID

Parameters:

pEventID - new value of interest

Returns:

same object to permit progressive setters

getEventID

public EventIdentifier getEventID()

Getter for eventID

Returns:

value of interest

setLocation

public IFFPdu setLocation(Vector3Float pLocation)

Setter for location

Parameters:

pLocation - new value of interest

Returns:

same object to permit progressive setters

getLocation

public Vector3Float getLocation()

Getter for location

Returns:

value of interest

setSystemID

public IFFPdu setSystemID(SystemIdentifier pSystemID)

Setter for systemID

Parameters:

pSystemID - new value of interest

Returns:

same object to permit progressive setters

getSystemID

public SystemIdentifier getSystemID()

Getter for systemID

Returns:

value of interest

setSystemDesignator

public IFFPdu setSystemDesignator(byte pSystemDesignator)

Setter for systemDesignator

Parameters:

pSystemDesignator - new value of interest

Returns:

same object to permit progressive setters

setSystemDesignator

public IFFPdu setSystemDesignator(int pSystemDesignator)

Utility setter for systemDesignator

Parameters:

pSystemDesignator - new value of interest

Returns:

same object to permit progressive setters

getSystemDesignator

public byte getSystemDesignator()

Getter for systemDesignator

Returns:

value of interest

setSystemSpecificData

public IFFPdu setSystemSpecificData(byte pSystemSpecificData)

Setter for systemSpecificData

Parameters:

pSystemSpecificData - new value of interest

Returns:

same object to permit progressive setters

setSystemSpecificData

public IFFPdu setSystemSpecificData(int pSystemSpecificData)

Utility setter for systemSpecificData

Parameters:

pSystemSpecificData - new value of interest

Returns:

same object to permit progressive setters

getSystemSpecificData

public byte getSystemSpecificData()

Getter for systemSpecificData

Returns:

value of interest

setFundamentalParameters

public IFFPdu setFundamentalParameters(FundamentalOperationalData pFundamentalParameters)

Setter for fundamentalParameters

Parameters:

pFundamentalParameters - new value of interest

Returns:

same object to permit progressive setters

getFundamentalParameters

public FundamentalOperationalData getFundamentalParameters()

Getter for fundamentalParameters

Returns:

value of interest

setIFFPduLayer2Data

public IFFPdu setIFFPduLayer2Data(IFFPduLayer2Data pIFFPduLayer2Data)

Setter for iFFPduLayer2Data

Parameters:

pIFFPduLayer2Data - new value of interest

Returns:

same object to permit progressive setters

getIFFPduLayer2Data

public IFFPduLayer2Data getIFFPduLayer2Data()

Getter for iFFPduLayer2Data

Returns:

value of interest

setIFFPduLayer3TransponderFormatData

public IFFPdu setIFFPduLayer3TransponderFormatData(IFFPduLayer3TransponderFormatData pIFFPduLayer3TransponderFormatData)

Setter for iFFPduLayer3TransponderFormatData

Parameters:

pIFFPduLayer3TransponderFormatData - new value of interest

Returns:

same object to permit progressive setters

getIFFPduLayer3TransponderFormatData

public IFFPduLayer3TransponderFormatData getIFFPduLayer3TransponderFormatData()

Getter for iFFPduLayer3TransponderFormatData

Returns:

value of interest

setIFFPduLayer3InterrogatorFormatData

public IFFPdu setIFFPduLayer3InterrogatorFormatData(IFFPduLayer3InterrogatorFormatData pIFFPduLayer3InterrogatorFormatData)

Setter for iFFPduLayer3InterrogatorFormatData

Parameters:

pIFFPduLayer3InterrogatorFormatData - new value of interest

Returns:

same object to permit progressive setters

getIFFPduLayer3InterrogatorFormatData

public IFFPduLayer3InterrogatorFormatData getIFFPduLayer3InterrogatorFormatData()

Getter for iFFPduLayer3InterrogatorFormatData

Returns:

value of interest

setIFFPduLayer4InterrogatorFormatData

public IFFPdu setIFFPduLayer4InterrogatorFormatData(IFFPduLayer4InterrogatorFormatData pIFFPduLayer4InterrogatorFormatData)

Setter for iFFPduLayer4InterrogatorFormatData

Parameters:

pIFFPduLayer4InterrogatorFormatData - new value of interest

Returns:

same object to permit progressive setters

getIFFPduLayer4InterrogatorFormatData

public IFFPduLayer4InterrogatorFormatData getIFFPduLayer4InterrogatorFormatData()

Getter for iFFPduLayer4InterrogatorFormatData

Returns:

value of interest

setIFFPduLayer4TransponderFormatData

public IFFPdu setIFFPduLayer4TransponderFormatData(IFFPduLayer4TransponderFormatData pIFFPduLayer4TransponderFormatData)

Setter for iFFPduLayer4TransponderFormatData

Parameters:

pIFFPduLayer4TransponderFormatData - new value of interest

Returns:

same object to permit progressive setters

getIFFPduLayer4TransponderFormatData

public IFFPduLayer4TransponderFormatData getIFFPduLayer4TransponderFormatData()

Getter for iFFPduLayer4TransponderFormatData

Returns:

value of interest

setIFFPduLayer5Data

public IFFPdu setIFFPduLayer5Data(IFFPduLayer5Data pIFFPduLayer5Data)

Setter for iFFPduLayer5Data

Parameters:

pIFFPduLayer5Data - new value of interest

Returns:

same object to permit progressive setters

getIFFPduLayer5Data

public IFFPduLayer5Data getIFFPduLayer5Data()

Getter for iFFPduLayer5Data

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 DistributedEmissionsRegenerationFamilyPdu

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 DistributedEmissionsRegenerationFamilyPdu

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 DistributedEmissionsRegenerationFamilyPdu

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 DistributedEmissionsRegenerationFamilyPdu

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 DistributedEmissionsRegenerationFamilyPdu

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 DistributedEmissionsRegenerationFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class DistributedEmissionsRegenerationFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase