Class AggregateStatePdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.EntityManagementFamilyPdu

edu.nps.moves.dis7.pdus.AggregateStatePdu

All Implemented Interfaces:

Marshaller, Serializable

public class AggregateStatePdu
extends EntityManagementFamilyPdu
implements Serializable

5.9.2.2 The Aggregate State PDU shall be used to communicate the state and other pertinent information about an aggregated unit.

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 AggregateIdentifier	aggregateID	ID of aggregated entities
protected List<AggregateIdentifier>	aggregateIDList	aggregates list
protected AggregateMarking	aggregateMarking	marking for aggregate; first char is charset type, rest is char data
protected AggregateStateAggregateState	aggregateState	state of aggregate uid 204
protected AggregateType	aggregateType	entity type of the aggregated entities
protected ByteArrayOutputStream	byteArrayOutputStream	byteArrayOutputStream (baos) is used for marshal/unmarshal serialization
protected Vector3Double	centerOfMass	center of mass of the aggregation
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected Vector3Float	dimensions	dimensions of bounding box for the aggregated entities, origin at the center of mass
protected List<EntityID>	entityIDList	entity ID list
protected ForceID	forceID	force ID provides a unique identifier uid 6
protected AggregateStateFormation	formation	formation of aggregated entities uid 205
static final String	NAME	The name of this PDU type
protected short	numberOfDisAggregates	number of aggregates
protected short	numberOfDisEntities	number of entities
protected short	numberOfSilentAggregateTypes	number of silent aggregate types
protected short	numberOfSilentEntityTypes	Number of silent entity types, handled automatically by marshaller at run time (and not modifiable by end-user programmers)
protected int	numberOfVariableDatumRecords	Number of variable datum records, handled automatically by marshaller at run time (and not modifiable by end-user programmers)
protected Vector3Float	orientation	orientation of the bounding box
protected List<EntityType>	silentAggregateSystemList	silent entity types
protected List<EntityType>	silentEntitySystemList	silent entity types
protected List<VariableDatum>	variableDatumList	variableDatums
protected Vector3Float	velocity	velocity of aggregation

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

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

Method Summary

Modifier and Type	Method	Description
AggregateStatePdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
AggregateStatePdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
AggregateStatePdu	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
AggregateIdentifier	getAggregateID()	Getter for aggregateID
List<AggregateIdentifier>	getAggregateIDList()	Getter for aggregateIDList
AggregateMarking	getAggregateMarking()	Getter for aggregateMarking
AggregateStateAggregateState	getAggregateState()	Getter for aggregateState
AggregateType	getAggregateType()	Getter for aggregateType
Vector3Double	getCenterOfMass()	Getter for centerOfMass
Vector3Float	getDimensions()	Getter for dimensions
List<EntityID>	getEntityIDList()	Getter for entityIDList
ForceID	getForceID()	Getter for forceID
AggregateStateFormation	getFormation()	Getter for formation
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
Vector3Float	getOrientation()	Getter for orientation
List<EntityType>	getSilentAggregateSystemList()	Getter for silentAggregateSystemList
List<EntityType>	getSilentEntitySystemList()	Getter for silentEntitySystemList
List<VariableDatum>	getVariableDatumList()	Getter for variableDatumList
Vector3Float	getVelocity()	Getter for velocity
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
AggregateStatePdu	setAggregateID(AggregateIdentifier pAggregateID)	Setter for aggregateID
AggregateStatePdu	setAggregateIDList(List<AggregateIdentifier> pAggregateIDList)	Setter for aggregateIDList
AggregateStatePdu	setAggregateMarking(AggregateMarking pAggregateMarking)	Setter for aggregateMarking
AggregateStatePdu	setAggregateState(AggregateStateAggregateState pAggregateState)	Setter for aggregateState
AggregateStatePdu	setAggregateType(AggregateType pAggregateType)	Setter for aggregateType
AggregateStatePdu	setCenterOfMass(Vector3Double pCenterOfMass)	Setter for centerOfMass
AggregateStatePdu	setDimensions(Vector3Float pDimensions)	Setter for dimensions
AggregateStatePdu	setEntityIDList(List<EntityID> pEntityIDList)	Setter for entityIDList
AggregateStatePdu	setForceID(ForceID pForceID)	Setter for forceID
AggregateStatePdu	setFormation(AggregateStateFormation pFormation)	Setter for formation
AggregateStatePdu	setOrientation(Vector3Float pOrientation)	Setter for orientation
AggregateStatePdu	setSilentAggregateSystemList(List<EntityType> pSilentAggregateSystemList)	Setter for silentAggregateSystemList
AggregateStatePdu	setSilentEntitySystemList(List<EntityType> pSilentEntitySystemList)	Setter for silentEntitySystemList
AggregateStatePdu	setVariableDatumList(List<VariableDatum> pVariableDatumList)	Setter for variableDatumList
AggregateStatePdu	setVelocity(Vector3Float pVelocity)	Setter for velocity
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

aggregateID

protected AggregateIdentifier aggregateID

ID of aggregated entities

forceID

protected ForceID forceID

force ID provides a unique identifier uid 6

aggregateState

protected AggregateStateAggregateState aggregateState

state of aggregate uid 204

aggregateType

protected AggregateType aggregateType

entity type of the aggregated entities

formation

protected AggregateStateFormation formation

formation of aggregated entities uid 205

aggregateMarking

protected AggregateMarking aggregateMarking

marking for aggregate; first char is charset type, rest is char data

dimensions

protected Vector3Float dimensions

dimensions of bounding box for the aggregated entities, origin at the center of mass

orientation

protected Vector3Float orientation

orientation of the bounding box

centerOfMass

protected Vector3Double centerOfMass

center of mass of the aggregation

velocity

protected Vector3Float velocity

velocity of aggregation

numberOfDisAggregates

protected short numberOfDisAggregates

number of aggregates

numberOfDisEntities

protected short numberOfDisEntities

number of entities

numberOfSilentAggregateTypes

protected short numberOfSilentAggregateTypes

number of silent aggregate types

numberOfSilentEntityTypes

protected short numberOfSilentEntityTypes

Number of silent entity types, handled automatically by marshaller at run time (and not modifiable by end-user programmers)

aggregateIDList

protected List<AggregateIdentifier> aggregateIDList

aggregates list

entityIDList

protected List<EntityID> entityIDList

entity ID list

silentAggregateSystemList

protected List<EntityType> silentAggregateSystemList

silent entity types

silentEntitySystemList

protected List<EntityType> silentEntitySystemList

silent entity types

numberOfVariableDatumRecords

protected int numberOfVariableDatumRecords

Number of variable datum records, handled automatically by marshaller at run time (and not modifiable by end-user programmers)

variableDatumList

protected List<VariableDatum> variableDatumList

variableDatums

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

AggregateStatePdu

public AggregateStatePdu()

Constructor creates and configures a new instance object

Method Details

copy

public AggregateStatePdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public AggregateStatePdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public AggregateStatePdu 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 EntityManagementFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setAggregateID

public AggregateStatePdu setAggregateID(AggregateIdentifier pAggregateID)

Setter for aggregateID

Parameters:

pAggregateID - new value of interest

Returns:

same object to permit progressive setters

getAggregateID

public AggregateIdentifier getAggregateID()

Getter for aggregateID

Returns:

value of interest

setForceID

public AggregateStatePdu setForceID(ForceID pForceID)

Setter for forceID

Parameters:

pForceID - new value of interest

Returns:

same object to permit progressive setters

getForceID

public ForceID getForceID()

Getter for forceID

Returns:

value of interest

setAggregateState

public AggregateStatePdu setAggregateState(AggregateStateAggregateState pAggregateState)

Setter for aggregateState

Parameters:

pAggregateState - new value of interest

Returns:

same object to permit progressive setters

getAggregateState

public AggregateStateAggregateState getAggregateState()

Getter for aggregateState

Returns:

value of interest

setAggregateType

public AggregateStatePdu setAggregateType(AggregateType pAggregateType)

Setter for aggregateType

Parameters:

pAggregateType - new value of interest

Returns:

same object to permit progressive setters

getAggregateType

public AggregateType getAggregateType()

Getter for aggregateType

Returns:

value of interest

setFormation

public AggregateStatePdu setFormation(AggregateStateFormation pFormation)

Setter for formation

Parameters:

pFormation - new value of interest

Returns:

same object to permit progressive setters

getFormation

public AggregateStateFormation getFormation()

Getter for formation

Returns:

value of interest

setAggregateMarking

public AggregateStatePdu setAggregateMarking(AggregateMarking pAggregateMarking)

Setter for aggregateMarking

Parameters:

pAggregateMarking - new value of interest

Returns:

same object to permit progressive setters

getAggregateMarking

public AggregateMarking getAggregateMarking()

Getter for aggregateMarking

Returns:

value of interest

setDimensions

public AggregateStatePdu setDimensions(Vector3Float pDimensions)

Setter for dimensions

Parameters:

pDimensions - new value of interest

Returns:

same object to permit progressive setters

getDimensions

public Vector3Float getDimensions()

Getter for dimensions

Returns:

value of interest

setOrientation

public AggregateStatePdu setOrientation(Vector3Float pOrientation)

Setter for orientation

Parameters:

pOrientation - new value of interest

Returns:

same object to permit progressive setters

getOrientation

public Vector3Float getOrientation()

Getter for orientation

Returns:

value of interest

setCenterOfMass

public AggregateStatePdu setCenterOfMass(Vector3Double pCenterOfMass)

Setter for centerOfMass

Parameters:

pCenterOfMass - new value of interest

Returns:

same object to permit progressive setters

getCenterOfMass

public Vector3Double getCenterOfMass()

Getter for centerOfMass

Returns:

value of interest

setVelocity

public AggregateStatePdu setVelocity(Vector3Float pVelocity)

Setter for velocity

Parameters:

pVelocity - new value of interest

Returns:

same object to permit progressive setters

getVelocity

public Vector3Float getVelocity()

Getter for velocity

Returns:

value of interest

setAggregateIDList

public AggregateStatePdu setAggregateIDList(List<AggregateIdentifier> pAggregateIDList)

Setter for aggregateIDList

Parameters:

pAggregateIDList - new value of interest

Returns:

same object to permit progressive setters

getAggregateIDList

public List<AggregateIdentifier> getAggregateIDList()

Getter for aggregateIDList

Returns:

value of interest

setEntityIDList

public AggregateStatePdu setEntityIDList(List<EntityID> pEntityIDList)

Setter for entityIDList

Parameters:

pEntityIDList - new value of interest

Returns:

same object to permit progressive setters

getEntityIDList

public List<EntityID> getEntityIDList()

Getter for entityIDList

Returns:

value of interest

setSilentAggregateSystemList

public AggregateStatePdu setSilentAggregateSystemList(List<EntityType> pSilentAggregateSystemList)

Setter for silentAggregateSystemList

Parameters:

pSilentAggregateSystemList - new value of interest

Returns:

same object to permit progressive setters

getSilentAggregateSystemList

public List<EntityType> getSilentAggregateSystemList()

Getter for silentAggregateSystemList

Returns:

value of interest

setSilentEntitySystemList

public AggregateStatePdu setSilentEntitySystemList(List<EntityType> pSilentEntitySystemList)

Setter for silentEntitySystemList

Parameters:

pSilentEntitySystemList - new value of interest

Returns:

same object to permit progressive setters

getSilentEntitySystemList

public List<EntityType> getSilentEntitySystemList()

Getter for silentEntitySystemList

Returns:

value of interest

setVariableDatumList

public AggregateStatePdu setVariableDatumList(List<VariableDatum> pVariableDatumList)

Setter for variableDatumList

Parameters:

pVariableDatumList - new value of interest

Returns:

same object to permit progressive setters

getVariableDatumList

public List<VariableDatum> getVariableDatumList()

Getter for variableDatumList

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 EntityManagementFamilyPdu

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 EntityManagementFamilyPdu

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 EntityManagementFamilyPdu

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 EntityManagementFamilyPdu

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 EntityManagementFamilyPdu

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 EntityManagementFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class EntityManagementFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase