Class IntercomControlPdu

java.lang.Object

edu.nps.moves.dis7.pdus.Pdu

edu.nps.moves.dis7.pdus.PduBase

edu.nps.moves.dis7.pdus.RadioCommunicationsFamilyPdu

edu.nps.moves.dis7.pdus.IntercomControlPdu

All Implemented Interfaces:

Marshaller, Serializable

public class IntercomControlPdu
extends RadioCommunicationsFamilyPdu
implements Serializable

5.8.7 Communicates the state of a particular intercom device, request an action of another intercom device, or respond to an action request.

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 IntercomControlCommand	command	detailed type requested. uid 182
protected byte	communicationsChannelType	control type
protected IntercomControlControlType	controlType	control type uid 180
protected DataOutputStream	dataOutputStream	dataOutputStream (dos) is used for marshal/unmarshal serialization
protected List<IntercomCommunicationsParameters>	intercomParameters	intercomParameters is an undescribed parameter...
protected int	intercomParametersLength	number of intercom parameters
protected short	masterChannelID	masterChannelID is an undescribed parameter...
protected short	masterIntercomNumber	specific intercom device that has created this intercom channel
protected EntityID	masterIntercomReferenceID	eid of the entity that has created this intercom channel, same comments as sourceEntityId
static final String	NAME	The name of this PDU type
protected EntityID	sourceEntityID	Source entity ID, this can also be ObjectIdentifier or UnattachedIdentifier
protected short	sourceIntercomNumber	The specific intercom device being simulated within an entity.
protected byte	sourceLineID	Line number to which the intercom control refers
protected IntercomControlTransmitLineState	transmitLineState	current transmit state of the line uid 183
protected byte	transmitPriority	priority of this message relative to transmissons from other intercom devices

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

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

Method Summary

Modifier and Type	Method	Description
IntercomControlPdu	copy()	copy method creates a deep copy of current object using preferred marshalling method
IntercomControlPdu	copyByteBuffer()	Creates a "deep copy" of current object using ByteBuffer methods.
IntercomControlPdu	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
IntercomControlCommand	getCommand()	Getter for command
byte	getCommunicationsChannelType()	Getter for communicationsChannelType
IntercomControlControlType	getControlType()	Getter for controlType
List<IntercomCommunicationsParameters>	getIntercomParameters()	Getter for intercomParameters
int	getMarshalledSize()	Returns size of this serialized (marshalled) object in bytes
short	getMasterChannelID()	Getter for masterChannelID
short	getMasterIntercomNumber()	Getter for masterIntercomNumber
EntityID	getMasterIntercomReferenceID()	Getter for masterIntercomReferenceID
EntityID	getSourceEntityID()	Getter for sourceEntityID
short	getSourceIntercomNumber()	Getter for sourceIntercomNumber
byte	getSourceLineID()	Getter for sourceLineID
IntercomControlTransmitLineState	getTransmitLineState()	Getter for transmitLineState
byte	getTransmitPriority()	Getter for transmitPriority
int	hashCode()
void	marshal(DataOutputStream dos)	Serializes an object to a DataOutputStream.
void	marshal(ByteBuffer byteBuffer)	Packs an object into the ByteBuffer.
IntercomControlPdu	setCommand(IntercomControlCommand pCommand)	Setter for command
IntercomControlPdu	setCommunicationsChannelType(byte pCommunicationsChannelType)	Setter for communicationsChannelType
IntercomControlPdu	setCommunicationsChannelType(int pCommunicationsChannelType)	Utility setter for communicationsChannelType
IntercomControlPdu	setControlType(IntercomControlControlType pControlType)	Setter for controlType
IntercomControlPdu	setIntercomParameters(List<IntercomCommunicationsParameters> pIntercomParameters)	Setter for intercomParameters
IntercomControlPdu	setMasterChannelID(int pMasterChannelID)	Utility setter for masterChannelID
IntercomControlPdu	setMasterChannelID(short pMasterChannelID)	Setter for masterChannelID
IntercomControlPdu	setMasterIntercomNumber(int pMasterIntercomNumber)	Utility setter for masterIntercomNumber
IntercomControlPdu	setMasterIntercomNumber(short pMasterIntercomNumber)	Setter for masterIntercomNumber
IntercomControlPdu	setMasterIntercomReferenceID(EntityID pMasterIntercomReferenceID)	Setter for masterIntercomReferenceID
IntercomControlPdu	setSourceEntityID(EntityID pSourceEntityID)	Setter for sourceEntityID
IntercomControlPdu	setSourceIntercomNumber(int pSourceIntercomNumber)	Utility setter for sourceIntercomNumber
IntercomControlPdu	setSourceIntercomNumber(short pSourceIntercomNumber)	Setter for sourceIntercomNumber
IntercomControlPdu	setSourceLineID(byte pSourceLineID)	Setter for sourceLineID
IntercomControlPdu	setSourceLineID(int pSourceLineID)	Utility setter for sourceLineID
IntercomControlPdu	setTransmitLineState(IntercomControlTransmitLineState pTransmitLineState)	Setter for transmitLineState
IntercomControlPdu	setTransmitPriority(byte pTransmitPriority)	Setter for transmitPriority
IntercomControlPdu	setTransmitPriority(int pTransmitPriority)	Utility setter for transmitPriority
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

controlType

protected IntercomControlControlType controlType

control type uid 180

communicationsChannelType

protected byte communicationsChannelType

control type

sourceEntityID

protected EntityID sourceEntityID

Source entity ID, this can also be ObjectIdentifier or UnattachedIdentifier

sourceIntercomNumber

protected short sourceIntercomNumber

The specific intercom device being simulated within an entity.

sourceLineID

protected byte sourceLineID

Line number to which the intercom control refers

transmitPriority

protected byte transmitPriority

priority of this message relative to transmissons from other intercom devices

transmitLineState

protected IntercomControlTransmitLineState transmitLineState

current transmit state of the line uid 183

command

protected IntercomControlCommand command

detailed type requested. uid 182

masterIntercomReferenceID

protected EntityID masterIntercomReferenceID

eid of the entity that has created this intercom channel, same comments as sourceEntityId

masterIntercomNumber

protected short masterIntercomNumber

specific intercom device that has created this intercom channel

masterChannelID

protected short masterChannelID

masterChannelID is an undescribed parameter...

intercomParametersLength

protected int intercomParametersLength

number of intercom parameters

intercomParameters

protected List<IntercomCommunicationsParameters> intercomParameters

intercomParameters 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

IntercomControlPdu

public IntercomControlPdu()

Constructor creates and configures a new instance object

Method Details

copy

public IntercomControlPdu copy()

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

Returns:

deep copy of PDU

copyByteBuffer

public IntercomControlPdu copyByteBuffer()

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

Returns:

deep copy of PDU

copyDataOutputStream

public IntercomControlPdu 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 RadioCommunicationsFamilyPdu

Returns:

serialized size in bytes

See Also:

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

setControlType

public IntercomControlPdu setControlType(IntercomControlControlType pControlType)

Setter for controlType

Parameters:

pControlType - new value of interest

Returns:

same object to permit progressive setters

getControlType

public IntercomControlControlType getControlType()

Getter for controlType

Returns:

value of interest

setCommunicationsChannelType

public IntercomControlPdu setCommunicationsChannelType(byte pCommunicationsChannelType)

Setter for communicationsChannelType

Parameters:

pCommunicationsChannelType - new value of interest

Returns:

same object to permit progressive setters

setCommunicationsChannelType

public IntercomControlPdu setCommunicationsChannelType(int pCommunicationsChannelType)

Utility setter for communicationsChannelType

Parameters:

pCommunicationsChannelType - new value of interest

Returns:

same object to permit progressive setters

getCommunicationsChannelType

public byte getCommunicationsChannelType()

Getter for communicationsChannelType

Returns:

value of interest

setSourceEntityID

public IntercomControlPdu setSourceEntityID(EntityID pSourceEntityID)

Setter for sourceEntityID

Parameters:

pSourceEntityID - new value of interest

Returns:

same object to permit progressive setters

getSourceEntityID

public EntityID getSourceEntityID()

Getter for sourceEntityID

Returns:

value of interest

setSourceIntercomNumber

public IntercomControlPdu setSourceIntercomNumber(short pSourceIntercomNumber)

Setter for sourceIntercomNumber

Parameters:

pSourceIntercomNumber - new value of interest

Returns:

same object to permit progressive setters

setSourceIntercomNumber

public IntercomControlPdu setSourceIntercomNumber(int pSourceIntercomNumber)

Utility setter for sourceIntercomNumber

Parameters:

pSourceIntercomNumber - new value of interest

Returns:

same object to permit progressive setters

getSourceIntercomNumber

public short getSourceIntercomNumber()

Getter for sourceIntercomNumber

Returns:

value of interest

setSourceLineID

public IntercomControlPdu setSourceLineID(byte pSourceLineID)

Setter for sourceLineID

Parameters:

pSourceLineID - new value of interest

Returns:

same object to permit progressive setters

setSourceLineID

public IntercomControlPdu setSourceLineID(int pSourceLineID)

Utility setter for sourceLineID

Parameters:

pSourceLineID - new value of interest

Returns:

same object to permit progressive setters

getSourceLineID

public byte getSourceLineID()

Getter for sourceLineID

Returns:

value of interest

setTransmitPriority

public IntercomControlPdu setTransmitPriority(byte pTransmitPriority)

Setter for transmitPriority

Parameters:

pTransmitPriority - new value of interest

Returns:

same object to permit progressive setters

setTransmitPriority

public IntercomControlPdu setTransmitPriority(int pTransmitPriority)

Utility setter for transmitPriority

Parameters:

pTransmitPriority - new value of interest

Returns:

same object to permit progressive setters

getTransmitPriority

public byte getTransmitPriority()

Getter for transmitPriority

Returns:

value of interest

setTransmitLineState

public IntercomControlPdu setTransmitLineState(IntercomControlTransmitLineState pTransmitLineState)

Setter for transmitLineState

Parameters:

pTransmitLineState - new value of interest

Returns:

same object to permit progressive setters

getTransmitLineState

public IntercomControlTransmitLineState getTransmitLineState()

Getter for transmitLineState

Returns:

value of interest

setCommand

public IntercomControlPdu setCommand(IntercomControlCommand pCommand)

Setter for command

Parameters:

pCommand - new value of interest

Returns:

same object to permit progressive setters

getCommand

public IntercomControlCommand getCommand()

Getter for command

Returns:

value of interest

setMasterIntercomReferenceID

public IntercomControlPdu setMasterIntercomReferenceID(EntityID pMasterIntercomReferenceID)

Setter for masterIntercomReferenceID

Parameters:

pMasterIntercomReferenceID - new value of interest

Returns:

same object to permit progressive setters

getMasterIntercomReferenceID

public EntityID getMasterIntercomReferenceID()

Getter for masterIntercomReferenceID

Returns:

value of interest

setMasterIntercomNumber

public IntercomControlPdu setMasterIntercomNumber(short pMasterIntercomNumber)

Setter for masterIntercomNumber

Parameters:

pMasterIntercomNumber - new value of interest

Returns:

same object to permit progressive setters

setMasterIntercomNumber

public IntercomControlPdu setMasterIntercomNumber(int pMasterIntercomNumber)

Utility setter for masterIntercomNumber

Parameters:

pMasterIntercomNumber - new value of interest

Returns:

same object to permit progressive setters

getMasterIntercomNumber

public short getMasterIntercomNumber()

Getter for masterIntercomNumber

Returns:

value of interest

setMasterChannelID

public IntercomControlPdu setMasterChannelID(short pMasterChannelID)

Setter for masterChannelID

Parameters:

pMasterChannelID - new value of interest

Returns:

same object to permit progressive setters

setMasterChannelID

public IntercomControlPdu setMasterChannelID(int pMasterChannelID)

Utility setter for masterChannelID

Parameters:

pMasterChannelID - new value of interest

Returns:

same object to permit progressive setters

getMasterChannelID

public short getMasterChannelID()

Getter for masterChannelID

Returns:

value of interest

setIntercomParameters

public IntercomControlPdu setIntercomParameters(List<IntercomCommunicationsParameters> pIntercomParameters)

Setter for intercomParameters

Parameters:

pIntercomParameters - new value of interest

Returns:

same object to permit progressive setters

getIntercomParameters

public List<IntercomCommunicationsParameters> getIntercomParameters()

Getter for intercomParameters

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 RadioCommunicationsFamilyPdu

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 RadioCommunicationsFamilyPdu

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 RadioCommunicationsFamilyPdu

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 RadioCommunicationsFamilyPdu

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 RadioCommunicationsFamilyPdu

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 RadioCommunicationsFamilyPdu

Parameters:

obj - the object to compare to

Returns:

true if the objects are equal, false otherwise.

toString

public String toString()

Overrides:

toString in class RadioCommunicationsFamilyPdu

hashCode

public int hashCode()

Overrides:

hashCode in class PduBase