Class AttributePdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.EntityInformationInteractionFamilyPdu

edu.nps.moves.dis7.pdus.AttributePdu

All Implemented Interfaces:

Marshaller, Serializable

public class AttributePdu
extends EntityInformationInteractionFamilyPdu
implements Serializable

7.2.6. Information about individual attributes for a particular entity, other object, or event may be communicated using an Attribute PDU. The Attribute PDU shall not be used to exchange data available in any other PDU except where explicitly mentioned in the PDU issuance instructions within this standard. See 5.3.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 DISAttributeActionCode	actionCode	This field shall identify the action code applicable to this Attribute PDU.
protected DisPduType	attributeRecordPduType	This field shall represent the type of the PDU that is being extended or updated, if applicable.
protected DISProtocolFamily	attributeRecordProtocolVersion	This field shall indicate the Protocol Version associated with the Attribute Record PDU Type.
protected List<AttributeRecordSet>	attributeRecordSets	attributeRecordSets is an undescribed parameter...
protected ByteArrayOutputStream	byteArrayOutputStream	byteArrayOutputStream (baos) is used for marshal/unmarshal serialization
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected VariableRecordType	masterAttributeRecordType	This field shall contain the Attribute record type of the Attribute records in the PDU if they all have the same Attribute record type.
static final String	NAME	The name of this PDU type
protected short	numberAttributeRecordSet	This field shall specify the number of Attribute Record Sets that make up the remainder of the PDU.
protected SimulationAddress	originatingSimulationAddress	This field shall identify the simulation issuing the Attribute PDU.
protected int	padding1	Padding
protected short	padding2	Padding
protected byte	padding3	Padding

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

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
AttributePdu()	Constructor creates and configures a new instance object

Method Summary

Modifier and Type	Method	Description
AttributePdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
AttributePdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
AttributePdu	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
DISAttributeActionCode	getActionCode()	Getter for actionCode
DisPduType	getAttributeRecordPduType()	Getter for attributeRecordPduType
DISProtocolFamily	getAttributeRecordProtocolVersion()	Getter for attributeRecordProtocolVersion
List<AttributeRecordSet>	getAttributeRecordSets()	Getter for attributeRecordSets
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
VariableRecordType	getMasterAttributeRecordType()	Getter for masterAttributeRecordType
SimulationAddress	getOriginatingSimulationAddress()	Getter for originatingSimulationAddress
int	getPadding1()	Getter for padding1
short	getPadding2()	Getter for padding2
byte	getPadding3()	Getter for padding3
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
AttributePdu	setActionCode(DISAttributeActionCode pActionCode)	Setter for actionCode
AttributePdu	setAttributeRecordPduType(DisPduType pAttributeRecordPduType)	Setter for attributeRecordPduType
AttributePdu	setAttributeRecordProtocolVersion(DISProtocolFamily pAttributeRecordProtocolVersion)	Setter for attributeRecordProtocolVersion
AttributePdu	setAttributeRecordSets(List<AttributeRecordSet> pAttributeRecordSets)	Setter for attributeRecordSets
AttributePdu	setMasterAttributeRecordType(VariableRecordType pMasterAttributeRecordType)	Setter for masterAttributeRecordType
AttributePdu	setOriginatingSimulationAddress(SimulationAddress pOriginatingSimulationAddress)	Setter for originatingSimulationAddress
AttributePdu	setPadding1(int pPadding1)	Setter for padding1
AttributePdu	setPadding2(int pPadding2)	Utility setter for padding2
AttributePdu	setPadding2(short pPadding2)	Setter for padding2
AttributePdu	setPadding3(byte pPadding3)	Setter for padding3
AttributePdu	setPadding3(int pPadding3)	Utility setter for padding3
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

originatingSimulationAddress

protected SimulationAddress originatingSimulationAddress

This field shall identify the simulation issuing the Attribute PDU. It shall be represented by a Simulation Address record (see 6.2.79).

padding1

protected int padding1

Padding

padding2

protected short padding2

Padding

attributeRecordPduType

protected DisPduType attributeRecordPduType

This field shall represent the type of the PDU that is being extended or updated, if applicable. It shall be represented by an 8-bit enumeration. uid 4

attributeRecordProtocolVersion

protected DISProtocolFamily attributeRecordProtocolVersion

This field shall indicate the Protocol Version associated with the Attribute Record PDU Type. It shall be represented by an 8-bit enumeration. uid 5

masterAttributeRecordType

protected VariableRecordType masterAttributeRecordType

This field shall contain the Attribute record type of the Attribute records in the PDU if they all have the same Attribute record type. It shall be represented by a 32-bit enumeration. uid 66 Variable Record Type values are defined by VariableRecordType enumerations

actionCode

protected DISAttributeActionCode actionCode

This field shall identify the action code applicable to this Attribute PDU. The Action Code shall apply to all Attribute records contained in the PDU. It shall be represented by an 8-bit enumeration. uid 295

padding3

protected byte padding3

Padding

numberAttributeRecordSet

protected short numberAttributeRecordSet

This field shall specify the number of Attribute Record Sets that make up the remainder of the PDU. It shall be represented by a 16-bit unsigned integer.

attributeRecordSets

protected List<AttributeRecordSet> attributeRecordSets

attributeRecordSets is an undescribed parameter...

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

AttributePdu

public AttributePdu()

Constructor creates and configures a new instance object

Method Details

copy

public AttributePdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public AttributePdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public AttributePdu 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 EntityInformationInteractionFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setOriginatingSimulationAddress

public AttributePdu setOriginatingSimulationAddress(SimulationAddress pOriginatingSimulationAddress)

Setter for originatingSimulationAddress

Parameters:

pOriginatingSimulationAddress - new value of interest

Returns:

same object to permit progressive setters

getOriginatingSimulationAddress

public SimulationAddress getOriginatingSimulationAddress()

Getter for originatingSimulationAddress

Returns:

value of interest

setPadding1

public AttributePdu setPadding1(int pPadding1)

Setter for padding1

Parameters:

pPadding1 - new value of interest

Returns:

same object to permit progressive setters

getPadding1

public int getPadding1()

Getter for padding1

Returns:

value of interest

setPadding2

public AttributePdu setPadding2(short pPadding2)

Setter for padding2

Parameters:

pPadding2 - new value of interest

Returns:

same object to permit progressive setters

setPadding2

public AttributePdu setPadding2(int pPadding2)

Utility setter for padding2

Parameters:

pPadding2 - new value of interest

Returns:

same object to permit progressive setters

getPadding2

public short getPadding2()

Getter for padding2

Returns:

value of interest

setAttributeRecordPduType

public AttributePdu setAttributeRecordPduType(DisPduType pAttributeRecordPduType)

Setter for attributeRecordPduType

Parameters:

pAttributeRecordPduType - new value of interest

Returns:

same object to permit progressive setters

getAttributeRecordPduType

public DisPduType getAttributeRecordPduType()

Getter for attributeRecordPduType

Returns:

value of interest

setAttributeRecordProtocolVersion

public AttributePdu setAttributeRecordProtocolVersion(DISProtocolFamily pAttributeRecordProtocolVersion)

Setter for attributeRecordProtocolVersion

Parameters:

pAttributeRecordProtocolVersion - new value of interest

Returns:

same object to permit progressive setters

getAttributeRecordProtocolVersion

public DISProtocolFamily getAttributeRecordProtocolVersion()

Getter for attributeRecordProtocolVersion

Returns:

value of interest

setMasterAttributeRecordType

public AttributePdu setMasterAttributeRecordType(VariableRecordType pMasterAttributeRecordType)

Setter for masterAttributeRecordType

Parameters:

pMasterAttributeRecordType - new value of interest

Returns:

same object to permit progressive setters

getMasterAttributeRecordType

public VariableRecordType getMasterAttributeRecordType()

Getter for masterAttributeRecordType

Returns:

value of interest

setActionCode

public AttributePdu setActionCode(DISAttributeActionCode pActionCode)

Setter for actionCode

Parameters:

pActionCode - new value of interest

Returns:

same object to permit progressive setters

getActionCode

public DISAttributeActionCode getActionCode()

Getter for actionCode

Returns:

value of interest

setPadding3

public AttributePdu setPadding3(byte pPadding3)

Setter for padding3

Parameters:

pPadding3 - new value of interest

Returns:

same object to permit progressive setters

setPadding3

public AttributePdu setPadding3(int pPadding3)

Utility setter for padding3

Parameters:

pPadding3 - new value of interest

Returns:

same object to permit progressive setters

getPadding3

public byte getPadding3()

Getter for padding3

Returns:

value of interest

setAttributeRecordSets

public AttributePdu setAttributeRecordSets(List<AttributeRecordSet> pAttributeRecordSets)

Setter for attributeRecordSets

Parameters:

pAttributeRecordSets - new value of interest

Returns:

same object to permit progressive setters

getAttributeRecordSets

public List<AttributeRecordSet> getAttributeRecordSets()

Getter for attributeRecordSets

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 EntityInformationInteractionFamilyPdu

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 EntityInformationInteractionFamilyPdu

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 EntityInformationInteractionFamilyPdu

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 EntityInformationInteractionFamilyPdu

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 EntityInformationInteractionFamilyPdu

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 EntityInformationInteractionFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class EntityInformationInteractionFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase