Package edu.nps.moves.dis7.pdus
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
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ByteArrayOutputStreambyteArrayOutputStream (baos) is used for marshal/unmarshal serializationprotected IntercomControlCommanddetailed type requested. uid 182protected bytecontrol typeprotected IntercomControlControlTypecontrol type uid 180protected DataOutputStreamdataOutputStream (dos) is used for marshal/unmarshal serializationprotected List<IntercomCommunicationsParameters> intercomParameters is an undescribed parameter...protected intnumber of intercom parametersprotected shortmasterChannelID is an undescribed parameter...protected shortspecific intercom device that has created this intercom channelprotected EntityIDeid of the entity that has created this intercom channel, same comments as sourceEntityIdstatic final StringThe name of this PDU typeprotected EntityIDSource entity ID, this can also be ObjectIdentifier or UnattachedIdentifierprotected shortThe specific intercom device being simulated within an entity.protected byteLine number to which the intercom control refersprotected IntercomControlTransmitLineStatecurrent transmit state of the line uid 183protected bytepriority of this message relative to transmissons from other intercom devicesFields inherited from class edu.nps.moves.dis7.pdus.RadioCommunicationsFamilyPdu
FAMILY_NAMEFields inherited from class edu.nps.moves.dis7.pdus.Pdu
exerciseID, length, pduType, protocolFamily, protocolVersion, timestamp -
Constructor Summary
ConstructorsConstructorDescriptionConstructor creates and configures a new instance object -
Method Summary
Modifier and TypeMethodDescriptioncopy()copy method creates a deep copy of current object using preferred marshalling methodCreates a "deep copy" of current object using ByteBuffer methods.copy method creates a deep copy of current object using DataOutputStream methods.booleanbooleanequalsImpl(Object obj) Compare all fields that contribute to the state, ignoring transient and static fields, forthisand the supplied objectGetter forcommandbyteGetter forcommunicationsChannelTypeGetter forcontrolTypeGetter forintercomParametersintReturns size of this serialized (marshalled) object in bytesshortGetter formasterChannelIDshortGetter formasterIntercomNumberGetter formasterIntercomReferenceIDGetter forsourceEntityIDshortGetter forsourceIntercomNumberbyteGetter forsourceLineIDGetter fortransmitLineStatebyteGetter fortransmitPriorityinthashCode()voidmarshal(DataOutputStream dos) Serializes an object to a DataOutputStream.voidmarshal(ByteBuffer byteBuffer) Packs an object into the ByteBuffer.setCommand(IntercomControlCommand pCommand) Setter forcommandsetCommunicationsChannelType(byte pCommunicationsChannelType) Setter forcommunicationsChannelTypesetCommunicationsChannelType(int pCommunicationsChannelType) Utility setter forcommunicationsChannelTypesetControlType(IntercomControlControlType pControlType) Setter forcontrolTypesetIntercomParameters(List<IntercomCommunicationsParameters> pIntercomParameters) Setter forintercomParameterssetMasterChannelID(int pMasterChannelID) Utility setter formasterChannelIDsetMasterChannelID(short pMasterChannelID) Setter formasterChannelIDsetMasterIntercomNumber(int pMasterIntercomNumber) Utility setter formasterIntercomNumbersetMasterIntercomNumber(short pMasterIntercomNumber) Setter formasterIntercomNumbersetMasterIntercomReferenceID(EntityID pMasterIntercomReferenceID) Setter formasterIntercomReferenceIDsetSourceEntityID(EntityID pSourceEntityID) Setter forsourceEntityIDsetSourceIntercomNumber(int pSourceIntercomNumber) Utility setter forsourceIntercomNumbersetSourceIntercomNumber(short pSourceIntercomNumber) Setter forsourceIntercomNumbersetSourceLineID(byte pSourceLineID) Setter forsourceLineIDsetSourceLineID(int pSourceLineID) Utility setter forsourceLineIDsetTransmitLineState(IntercomControlTransmitLineState pTransmitLineState) Setter fortransmitLineStatesetTransmitPriority(byte pTransmitPriority) Setter fortransmitPrioritysetTransmitPriority(int pTransmitPriority) Utility setter fortransmitPrioritytoString()intunmarshal(DataInputStream dis) Deserializes an object from a DataInputStream.intunmarshal(ByteBuffer byteBuffer) Unpacks a Pdu from the underlying data.Methods inherited from class edu.nps.moves.dis7.pdus.PduBase
getPadding, getPduStatus, setPadding, setPadding, setPduStatusMethods 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
-
Field Details
-
NAME
-
controlType
control type uid 180 -
communicationsChannelType
protected byte communicationsChannelTypecontrol type -
sourceEntityID
Source entity ID, this can also be ObjectIdentifier or UnattachedIdentifier -
sourceIntercomNumber
protected short sourceIntercomNumberThe specific intercom device being simulated within an entity. -
sourceLineID
protected byte sourceLineIDLine number to which the intercom control refers -
transmitPriority
protected byte transmitPrioritypriority of this message relative to transmissons from other intercom devices -
transmitLineState
current transmit state of the line uid 183 -
command
detailed type requested. uid 182 -
masterIntercomReferenceID
eid of the entity that has created this intercom channel, same comments as sourceEntityId -
masterIntercomNumber
protected short masterIntercomNumberspecific intercom device that has created this intercom channel -
masterChannelID
protected short masterChannelIDmasterChannelID is an undescribed parameter... -
intercomParametersLength
protected int intercomParametersLengthnumber of intercom parameters -
intercomParameters
intercomParameters is an undescribed parameter... -
byteArrayOutputStream
byteArrayOutputStream (baos) is used for marshal/unmarshal serialization- See Also:
-
dataOutputStream
dataOutputStream (dos) is used for marshal/unmarshal serialization- See Also:
-
-
Constructor Details
-
IntercomControlPdu
public IntercomControlPdu()Constructor creates and configures a new instance object
-
-
Method Details
-
copy
copy method creates a deep copy of current object using preferred marshalling method- Returns:
- deep copy of PDU
-
copyByteBuffer
Creates a "deep copy" of current object using ByteBuffer methods.- Returns:
- deep copy of PDU
-
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:
getMarshalledSizein interfaceMarshaller- Overrides:
getMarshalledSizein classRadioCommunicationsFamilyPdu- Returns:
- serialized size in bytes
- See Also:
-
setControlType
Setter forcontrolType- Parameters:
pControlType- new value of interest- Returns:
- same object to permit progressive setters
-
getControlType
Getter forcontrolType- Returns:
- value of interest
-
setCommunicationsChannelType
Setter forcommunicationsChannelType- Parameters:
pCommunicationsChannelType- new value of interest- Returns:
- same object to permit progressive setters
-
setCommunicationsChannelType
Utility setter forcommunicationsChannelType- Parameters:
pCommunicationsChannelType- new value of interest- Returns:
- same object to permit progressive setters
-
getCommunicationsChannelType
public byte getCommunicationsChannelType()Getter forcommunicationsChannelType- Returns:
- value of interest
-
setSourceEntityID
Setter forsourceEntityID- Parameters:
pSourceEntityID- new value of interest- Returns:
- same object to permit progressive setters
-
getSourceEntityID
-
setSourceIntercomNumber
Setter forsourceIntercomNumber- Parameters:
pSourceIntercomNumber- new value of interest- Returns:
- same object to permit progressive setters
-
setSourceIntercomNumber
Utility setter forsourceIntercomNumber- Parameters:
pSourceIntercomNumber- new value of interest- Returns:
- same object to permit progressive setters
-
getSourceIntercomNumber
-
setSourceLineID
Setter forsourceLineID- Parameters:
pSourceLineID- new value of interest- Returns:
- same object to permit progressive setters
-
setSourceLineID
Utility setter forsourceLineID- Parameters:
pSourceLineID- new value of interest- Returns:
- same object to permit progressive setters
-
getSourceLineID
-
setTransmitPriority
Setter fortransmitPriority- Parameters:
pTransmitPriority- new value of interest- Returns:
- same object to permit progressive setters
-
setTransmitPriority
Utility setter fortransmitPriority- Parameters:
pTransmitPriority- new value of interest- Returns:
- same object to permit progressive setters
-
getTransmitPriority
-
setTransmitLineState
Setter fortransmitLineState- Parameters:
pTransmitLineState- new value of interest- Returns:
- same object to permit progressive setters
-
getTransmitLineState
Getter fortransmitLineState- Returns:
- value of interest
-
setCommand
Setter forcommand- Parameters:
pCommand- new value of interest- Returns:
- same object to permit progressive setters
-
getCommand
-
setMasterIntercomReferenceID
Setter formasterIntercomReferenceID- Parameters:
pMasterIntercomReferenceID- new value of interest- Returns:
- same object to permit progressive setters
-
getMasterIntercomReferenceID
Getter formasterIntercomReferenceID- Returns:
- value of interest
-
setMasterIntercomNumber
Setter formasterIntercomNumber- Parameters:
pMasterIntercomNumber- new value of interest- Returns:
- same object to permit progressive setters
-
setMasterIntercomNumber
Utility setter formasterIntercomNumber- Parameters:
pMasterIntercomNumber- new value of interest- Returns:
- same object to permit progressive setters
-
getMasterIntercomNumber
-
setMasterChannelID
Setter formasterChannelID- Parameters:
pMasterChannelID- new value of interest- Returns:
- same object to permit progressive setters
-
setMasterChannelID
Utility setter formasterChannelID- Parameters:
pMasterChannelID- new value of interest- Returns:
- same object to permit progressive setters
-
getMasterChannelID
-
setIntercomParameters
public IntercomControlPdu setIntercomParameters(List<IntercomCommunicationsParameters> pIntercomParameters) Setter forintercomParameters- Parameters:
pIntercomParameters- new value of interest- Returns:
- same object to permit progressive setters
-
getIntercomParameters
Getter forintercomParameters- Returns:
- value of interest
-
marshal
Serializes an object to a DataOutputStream.- Specified by:
marshalin interfaceMarshaller- Overrides:
marshalin classRadioCommunicationsFamilyPdu- Parameters:
dos- the OutputStream- Throws:
Exception- if something goes wrong- See Also:
-
unmarshal
Deserializes an object from a DataInputStream.- Specified by:
unmarshalin interfaceMarshaller- Overrides:
unmarshalin classRadioCommunicationsFamilyPdu- Parameters:
dis- the InputStream- Returns:
- marshalled serialized size in bytes
- Throws:
Exception- if something goes wrong- See Also:
-
marshal
Packs an object into the ByteBuffer.- Specified by:
marshalin interfaceMarshaller- Overrides:
marshalin classRadioCommunicationsFamilyPdu- Parameters:
byteBuffer- The ByteBuffer at the position to begin writing- Throws:
BufferOverflowException- if byteBuffer is too smallReadOnlyBufferException- if byteBuffer is read onlyException- ByteBuffer-generated exception- See Also:
-
unmarshal
Unpacks a Pdu from the underlying data.- Specified by:
unmarshalin interfaceMarshaller- Overrides:
unmarshalin classRadioCommunicationsFamilyPdu- Parameters:
byteBuffer- The ByteBuffer at the position to begin reading- Returns:
- marshalled serialized size in bytes
- Throws:
BufferUnderflowException- if byteBuffer is too smallException- ByteBuffer-generated exception- See Also:
-
equals
- Overrides:
equalsin classRadioCommunicationsFamilyPdu
-
equalsImpl
Description copied from class:PduCompare all fields that contribute to the state, ignoring transient and static fields, forthisand the supplied object- Overrides:
equalsImplin classRadioCommunicationsFamilyPdu- Parameters:
obj- the object to compare to- Returns:
- true if the objects are equal, false otherwise.
-
toString
- Overrides:
toStringin classRadioCommunicationsFamilyPdu
-
hashCode
-