Post

TransmitterPdu

Posted Updated
By CREATE3000 9 min read

Overview

TransmitterPdu is a networked Protocol Data Unit (PDU) information node that provides detailed information about a radio transmitter modeled in a simulation.

The TransmitterPdu node belongs to the DIS component and requires at least level 1, its default container field is children. It is available from X3D version 3.0 or higher.

Hierarchy

1
2
3
4
5

+ X3DNode
  + X3DChildNode
    + X3DSensorNode
      + X3DNetworkSensorNode
        + TransmitterPdu (X3DBoundedObject)*

* Derived from multiple interfaces.

Fields

SFNode [in, out] metadata NULL [X3DMetadataObject]

Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.

Hint

SFString [in, out] description “”

Author-provided prose that describes intended purpose of the node.

Hint

  • Many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for “ quotation-mark character).

SFBool [in, out] visible TRUE

Whether or not renderable content within this node is visually displayed.

Hints

  • The visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
  • Content must be visible to be collidable and to be pickable.

SFBool [in, out] bboxDisplay FALSE

Whether to display bounding box for associated geometry, aligned with world coordinates.

Hint

  • The bounding box is displayed regardless of whether contained content is visible.

SFVec3f [ ] bboxSize -1 -1 -1 [0,∞) or −1 −1 −1

Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.

Hints

SFVec3f [ ] bboxCenter 0 0 0 (-∞,∞)

Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.

Hints

SFBool [in, out] enabled TRUE

Enables/disables the sensor node.

SFBool [out] isActive

Confirm whether there has been a recent network update.

Warning

  • It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

SFString [in, out] address “localhost”

Multicast network address, or else ‘localhost’. Example: 224.2.181.145.

SFVec3f [in, out] antennaLocation 0 0 0 (-∞,∞)

World coordinates for antenna location.

SFInt32 [in, out] antennaPatternLength 0 [0,65535]

Input/Output field antennaPatternLength.

SFInt32 [in, out] antennaPatternType 0 [0,65535]

Antenna shape pattern: 0 for omnidirectional, 1 for beam, 2 for spherical harmonic (deprecated), or optional higher value

SFInt32 [in, out] applicationID 0 [0,65535]

Each simulation application that can respond to simulation management PDUs needs to have a unique applicationID.

SFInt32 [in, out] cryptoKeyID 0 [0,65535]

Nonzero value corresponding to the simulated cryptographic key. Enumerations value 0 indicates plain (unencrypted) communications.

SFInt32 [in, out] cryptoSystem 0 [0,65535]

Indicates type of crypto system being used, even if the encryption equipment is not keyed. Value 0 for No Encryption Device, higher enumerations values correspond to other specific equipment.

SFInt32 [in, out] entityID 0 [0,65535]

EntityID unique ID for entity within that application.

SFInt32 [in, out] frequency

Transmission frequency in Hz. If the radio is in frequency hopping mode, this field may be set to the center of the frequency hopping band currently in use, or to some other appropriate value.

SFInt32 [in, out] inputSource 0 [0,255]

Source of transmission input. Enumerations value 0 for Other, 1 for Pilot, 2 for Copilot, 3 for First Officer, 4 for Driver, 5 for Loader, 6 for Gunner, 7 for Commander, 8 for Digital Data Device, 9 for Intercom, 10 for Audio Jammer, 11 for Data Jammer, 12 for GPS Jammer, 13 for GPS Meaconer (masking beacon).

SFInt32 [in, out] lengthOfModulationParameters 0 [0,255]

Input/Output field lengthOfModulationParameters.

SFInt32 [in, out] modulationTypeDetail 0 [0,65535]

Integer enumeration containing detailed information depending on the major modulation type.

SFInt32 [in, out] modulationTypeMajor 0 [0,65535]

Integer enumeration containing major classification of the modulation type. Enumerations value 0 for No Statement, 1 for Amplitude, 2 for Amplitude and Angle, 3 for Angle, 4 for Combination, 5 for Pulse, 6 for Unmodulated, 7 for Carrier Phase Shift Modulation (CPSM).

SFInt32 [in, out] modulationTypeSpreadSpectrum 0 [0,65535]

Indicates the spread spectrum technique or combination of spread spectrum techniques in use.

SFInt32 [in, out] modulationTypeSystem 0 [0,65535]

Specifies radio system associated with this Transmitter PDU and used to interpret other fields whose values depend on a specific radio system.

SFString [in, out] multicastRelayHost “”

Fallback server address if multicast not available locally. For example: track.nps.edu.

SFInt32 [in, out] multicastRelayPort 0 [0,65535]

Fallback server port if multicast not available locally. For example: 8010.

SFString [in, out] networkMode “standAlone” [“standAlone”|”networkReader”|”networkWriter”]

Whether this entity is ignoring the network, sending DIS packets to the network, or receiving DIS packets from the network. (1) standAlone: ignore network but still respond to events in local scene. (2) networkReader: listen to network and read PDU packets at readInterval, act as remotely linked copy of entity. (3) networkWriter: send PDU packets to network at writeInterval, act as master entity. Default value “standAlone” ensures that DIS network activation within a scene as networkReader or networkWriter is intentional.

Warnings

  • Do not wrap extra quotation marks around these SFString enumeration values, since “quotation” “marks” are only used for MFString values.
  • Network activity may have associated security issues.

SFInt32 [in, out] port 0 [0,65535]

Multicast network port, for example: 3000.

SFFloat [in, out] power 0 (0,∞)

Power that radio would be capable of outputting if on and transmitting, independent of actual transmit state of the radio.

SFInt32 [in, out] radioEntityTypeCategory 0 [0,255]

Integer enumeration containing EntityType of transmitter radio. Enumerations value: 0 for Other, 1 for Generic Radio or Simple Intercom, 2 for HAVE QUICK, 3 for HAVE QUICK II, 4 for HAVE QUICK IIA, 5 for SINCGARS, 6 for CCTT SINCGARS, 7 for EPLRS (Enhanced Position Location Reporting System), 8 for JTIDS/MIDS, 9 for Link 11, 10 for Link 11B, 11 for L-Band SATCOM, 12 for Enhanced SINCGARS 7.3, 13 for Navigation Aid.

SFInt32 [in, out] radioEntityTypeCountry 0 [0,65535]

Integer enumerations value for country to which the design of the entity or its design specification is attributed.

SFInt32 [in, out] radioEntityTypeDomain 0 [0,255]

Integer enumerations value for domain in which the entity operates: LAND, AIR, SURFACE, SUBSURFACE, SPACE or OTHER.

SFInt32 [in, out] radioEntityTypeKind 0 [0,255]

Integer enumerations value for whether entity is a PLATFORM, MUNITION, LIFE_FORM, ENVIRONMENTAL, CULTURAL_FEATURE, SUPPLY, RADIO, EXPENDABLE, SENSOR_EMITTER or OTHER.

SFInt32 [in, out] radioEntityTypeNomenclature 0 [0,255]

Integer enumerations value indicating nomenclature (name) for a particular emitter. See DIS enumerations reference for value/name pairs.

SFInt32 [in, out] radioEntityTypeNomenclatureVersion 0 [0,65535]

Named equipment version number.

SFInt32 [in, out] radioID 0 [0,255]

Identifies a particular radio within a given entity.

SFTime [in, out] readInterval 0.1 (0,∞)

Seconds between read updates, 0 means no reading.

Hint

  • readInterval is a nonnegative SFTime duration interval, not an absolute clock time.

SFVec3f [in, out] relativeAntennaLocation 0 0 0 (-∞,∞)

Relative coordinates for antenna location.

SFBool [in, out] rtpHeaderExpected FALSE

Whether RTP headers are prepended to DIS PDUs.

SFInt32 [in, out] siteID 0 [0,65535]

Simulation/exercise siteID of the participating LAN or organization.

SFFloat [in, out] transmitFrequencyBandwidth 0 (-∞,∞)

Bandwidth of the particular transmitter measured between the half-power (-3 dB) points (this value represents total bandwidth, not the deviation from the center frequency).

SFInt32 [in, out] transmitState 0 [0,255]

Specify radio transmission state where enumerations value 0 is for off, value 1 for powered but not transmitting, or value 1 is for powered and transmitting,

SFInt32 [in, out] whichGeometry 1 [-1,∞)

Select geometry to render: -1 for no geometry, 0 for text trace, 1 for default geometry, (optional) higher values to render different states.

SFTime [in, out] writeInterval 1 [0,∞)

Seconds between write updates, 0 means no writing (sending).

Hint

  • writeInterval is a nonnegative SFTime duration interval, not an absolute clock time.

SFBool [out] isNetworkReader

Whether networkMode=’remote’ (listen to network as copy of remote entity).

Warning

  • It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

SFBool [out] isNetworkWriter

Whether networkMode=’master’ (output to network as master entity at writeInterval).

Warning

  • It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

SFBool [out] isRtpHeaderHeard

Whether incoming DIS packets have an RTP header prepended.

Warning

  • It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

SFBool [out] isStandAlone

Whether networkMode=’local’ (ignore network but still respond to local events).

Warning

  • It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

SFTime [out] timestamp

DIS timestamp in X3D units (value 0.0 matches 1 January 1970) in seconds.

Warning

  • It is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

SFVec3d [in, out] geoCoords 0 0 0 (-∞,∞)

Geographic location (specified in current geoSystem coordinates) for children geometry (specified in relative coordinate system, in meters).

Hint

Warning

  • Requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>

MFString [ ] geoSystem [ “GD”, “WE” ]

Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse Mercator (UTM). Supported values: “GD” “UTM” or “GC” followed by additional quoted string parameters as appropriate for the type.

Hints

Warning

  • Deprecated values are GDC (replaced by GD) and GCC (replaced by GC).

Advice

Hints

Warning

  • Requires X3D profile='Full' or else include <component name='DIS' level='1'/>

See Also

DIS

components, DIS
TransmitterPdu DIS
This post is licensed under CC BY 4.0 by the author.