Class AppearancePdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.LiveEntityFamilyPdu

edu.nps.moves.dis7.pdus.AppearancePdu

All Implemented Interfaces:

Marshaller, Serializable

public class AppearancePdu
extends LiveEntityFamilyPdu
implements Serializable

9.4.3 Communicate information about the appearance of a live 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 EntityType	alternateEntityType	alternateEntityType is an undescribed parameter...
protected Appearance	appearanceFields	appearanceFields is an undescribed parameter...
protected short	appearanceFlags	16-bit bit field
protected ByteArrayOutputStream	byteArrayOutputStream	byteArrayOutputStream (baos) is used for marshal/unmarshal serialization
protected EntityCapabilities	capabilities	uid 55
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected EntityMarking	entityMarking	entityMarking is an undescribed parameter...
protected EntityType	entityType	entityType is an undescribed parameter...
protected ForceID	forceId	uid 6
protected EntityID	liveEntityId	liveEntityId is an undescribed parameter...
static final String	NAME	The name of this PDU type

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

FAMILY_NAME

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

exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AppearancePdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
AppearancePdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
AppearancePdu	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
EntityType	getAlternateEntityType()	Getter for alternateEntityType
Appearance	getAppearanceFields()	Getter for appearanceFields
short	getAppearanceFlags()	Getter for appearanceFlags
EntityCapabilities	getCapabilities()	Getter for capabilities
EntityMarking	getEntityMarking()	Getter for entityMarking
EntityType	getEntityType()	Getter for entityType
ForceID	getForceId()	Getter for forceId
EntityID	getLiveEntityId()	Getter for liveEntityId
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
AppearancePdu	setAlternateEntityType(EntityType pAlternateEntityType)	Setter for alternateEntityType
AppearancePdu	setAppearanceFields(Appearance pAppearanceFields)	Setter for appearanceFields
AppearancePdu	setAppearanceFlags(int pAppearanceFlags)	Utility setter for appearanceFlags
AppearancePdu	setAppearanceFlags(short pAppearanceFlags)	Setter for appearanceFlags
AppearancePdu	setCapabilities(EntityCapabilities pCapabilities)	Setter for capabilities
AppearancePdu	setEntityMarking(EntityMarking pEntityMarking)	Setter for entityMarking
AppearancePdu	setEntityType(EntityType pEntityType)	Setter for entityType
AppearancePdu	setForceId(ForceID pForceId)	Setter for forceId
AppearancePdu	setLiveEntityId(EntityID pLiveEntityId)	Setter for liveEntityId
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.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

liveEntityId

protected EntityID liveEntityId

liveEntityId is an undescribed parameter...

appearanceFlags

protected short appearanceFlags

16-bit bit field

forceId

protected ForceID forceId

uid 6

entityType

protected EntityType entityType

entityType is an undescribed parameter...

alternateEntityType

protected EntityType alternateEntityType

alternateEntityType is an undescribed parameter...

entityMarking

protected EntityMarking entityMarking

entityMarking is an undescribed parameter...

capabilities

protected EntityCapabilities capabilities

uid 55

appearanceFields

protected Appearance appearanceFields

appearanceFields 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

AppearancePdu

public AppearancePdu()

Constructor creates and configures a new instance object

Method Details

copy

public AppearancePdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public AppearancePdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public AppearancePdu 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 LiveEntityFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setLiveEntityId

public AppearancePdu setLiveEntityId(EntityID pLiveEntityId)

Setter for liveEntityId

Parameters:

pLiveEntityId - new value of interest

Returns:

same object to permit progressive setters

getLiveEntityId

public EntityID getLiveEntityId()

Getter for liveEntityId

Returns:

value of interest

setAppearanceFlags

public AppearancePdu setAppearanceFlags(short pAppearanceFlags)

Setter for appearanceFlags

Parameters:

pAppearanceFlags - new value of interest

Returns:

same object to permit progressive setters

setAppearanceFlags

public AppearancePdu setAppearanceFlags(int pAppearanceFlags)

Utility setter for appearanceFlags

Parameters:

pAppearanceFlags - new value of interest

Returns:

same object to permit progressive setters

getAppearanceFlags

public short getAppearanceFlags()

Getter for appearanceFlags

Returns:

value of interest

setForceId

public AppearancePdu 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

setEntityType

public AppearancePdu setEntityType(EntityType pEntityType)

Setter for entityType

Parameters:

pEntityType - new value of interest

Returns:

same object to permit progressive setters

getEntityType

public EntityType getEntityType()

Getter for entityType

Returns:

value of interest

setAlternateEntityType

public AppearancePdu setAlternateEntityType(EntityType pAlternateEntityType)

Setter for alternateEntityType

Parameters:

pAlternateEntityType - new value of interest

Returns:

same object to permit progressive setters

getAlternateEntityType

public EntityType getAlternateEntityType()

Getter for alternateEntityType

Returns:

value of interest

setEntityMarking

public AppearancePdu setEntityMarking(EntityMarking pEntityMarking)

Setter for entityMarking

Parameters:

pEntityMarking - new value of interest

Returns:

same object to permit progressive setters

getEntityMarking

public EntityMarking getEntityMarking()

Getter for entityMarking

Returns:

value of interest

setCapabilities

public AppearancePdu setCapabilities(EntityCapabilities pCapabilities)

Setter for capabilities

Parameters:

pCapabilities - new value of interest

Returns:

same object to permit progressive setters

getCapabilities

public EntityCapabilities getCapabilities()

Getter for capabilities

Returns:

value of interest

setAppearanceFields

public AppearancePdu setAppearanceFields(Appearance pAppearanceFields)

Setter for appearanceFields

Parameters:

pAppearanceFields - new value of interest

Returns:

same object to permit progressive setters

getAppearanceFields

public Appearance getAppearanceFields()

Getter for appearanceFields

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 LiveEntityFamilyPdu

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 LiveEntityFamilyPdu

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 LiveEntityFamilyPdu

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 LiveEntityFamilyPdu

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 LiveEntityFamilyPdu

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 LiveEntityFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class LiveEntityFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class Pdu