Class IsGroupOfPdu

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.IsGroupOfPdu

All Implemented Interfaces:

Marshaller, Serializable

public class IsGroupOfPdu
extends EntityManagementFamilyPdu
implements Serializable

5.9.3.1 The IsGroupOf PDU shall communicate information about the individual states of a group of entities, including state information that is necessary for the receiving simulation applications to represent the issuing group of entities in the simulation applications’ own simulation.

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 IsGroupOfGroupedEntityCategory	groupedEntityCategory	type of entities constituting the group uid 213
protected List<VariableDatum>	groupedEntityDescriptions	GED records about each individual entity in the group.
protected EntityID	groupEntityID	ID of aggregated entities
protected double	latitude	latitude
protected double	longitude	longitude
static final String	NAME	The name of this PDU type
protected byte	numberOfGroupedEntities	Number of individual entities constituting the group
protected int	pad	padding

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

Method Summary

Modifier and Type	Method	Description
IsGroupOfPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
IsGroupOfPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
IsGroupOfPdu	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
IsGroupOfGroupedEntityCategory	getGroupedEntityCategory()	Getter for groupedEntityCategory
List<VariableDatum>	getGroupedEntityDescriptions()	Getter for groupedEntityDescriptions
EntityID	getGroupEntityID()	Getter for groupEntityID
double	getLatitude()	Getter for latitude
double	getLongitude()	Getter for longitude
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
int	getPad()	Getter for pad
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
IsGroupOfPdu	setGroupedEntityCategory(IsGroupOfGroupedEntityCategory pGroupedEntityCategory)	Setter for groupedEntityCategory
IsGroupOfPdu	setGroupedEntityDescriptions(List<VariableDatum> pGroupedEntityDescriptions)	Setter for groupedEntityDescriptions
IsGroupOfPdu	setGroupEntityID(EntityID pGroupEntityID)	Setter for groupEntityID
IsGroupOfPdu	setLatitude(double pLatitude)	Setter for latitude
IsGroupOfPdu	setLongitude(double pLongitude)	Setter for longitude
IsGroupOfPdu	setPad(int pPad)	Setter for pad
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

groupEntityID

protected EntityID groupEntityID

ID of aggregated entities

groupedEntityCategory

protected IsGroupOfGroupedEntityCategory groupedEntityCategory

type of entities constituting the group uid 213

numberOfGroupedEntities

protected byte numberOfGroupedEntities

Number of individual entities constituting the group

pad

protected int pad

padding

latitude

protected double latitude

latitude

longitude

protected double longitude

longitude

groupedEntityDescriptions

protected List<VariableDatum> groupedEntityDescriptions

GED records about each individual entity in the group. Bad specing--the Group Entity Descriptions are not described.

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

IsGroupOfPdu

public IsGroupOfPdu()

Constructor creates and configures a new instance object

Method Details

copy

public IsGroupOfPdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public IsGroupOfPdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public IsGroupOfPdu 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)

setGroupEntityID

public IsGroupOfPdu setGroupEntityID(EntityID pGroupEntityID)

Setter for groupEntityID

Parameters:

pGroupEntityID - new value of interest

Returns:

same object to permit progressive setters

getGroupEntityID

public EntityID getGroupEntityID()

Getter for groupEntityID

Returns:

value of interest

setGroupedEntityCategory

public IsGroupOfPdu setGroupedEntityCategory(IsGroupOfGroupedEntityCategory pGroupedEntityCategory)

Setter for groupedEntityCategory

Parameters:

pGroupedEntityCategory - new value of interest

Returns:

same object to permit progressive setters

getGroupedEntityCategory

public IsGroupOfGroupedEntityCategory getGroupedEntityCategory()

Getter for groupedEntityCategory

Returns:

value of interest

setPad

public IsGroupOfPdu setPad(int pPad)

Setter for pad

Parameters:

pPad - new value of interest

Returns:

same object to permit progressive setters

getPad

public int getPad()

Getter for pad

Returns:

value of interest

setLatitude

public IsGroupOfPdu setLatitude(double pLatitude)

Setter for latitude

Parameters:

pLatitude - new value of interest

Returns:

same object to permit progressive setters

getLatitude

public double getLatitude()

Getter for latitude

Returns:

value of interest

setLongitude

public IsGroupOfPdu setLongitude(double pLongitude)

Setter for longitude

Parameters:

pLongitude - new value of interest

Returns:

same object to permit progressive setters

getLongitude

public double getLongitude()

Getter for longitude

Returns:

value of interest

setGroupedEntityDescriptions

public IsGroupOfPdu setGroupedEntityDescriptions(List<VariableDatum> pGroupedEntityDescriptions)

Setter for groupedEntityDescriptions

Parameters:

pGroupedEntityDescriptions - new value of interest

Returns:

same object to permit progressive setters

getGroupedEntityDescriptions

public List<VariableDatum> getGroupedEntityDescriptions()

Getter for groupedEntityDescriptions

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