Post

SignalPdu

Posted Updated
By CREATE3000
7 min read
SignalPdu

Overview

SignalPdu is a networked Protocol Data Unit (PDU) information node that communicates the transmission of voice, audio or other data modeled in a simulation.

The SignalPdu 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
        + SignalPdu (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.

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

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

MFInt32 [in, out] data [ ] [0,255]

Holds audio or digital data conveyed by the radio transmission. Interpretation of the field depends on values of encodingScheme and tdlType fields.

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

Number of bits of digital voice audio or digital data being sent in the Signal PDU. If the Encoding Class is database index, then dataLength field is set to 96.

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

Designates both Encoding Class and Encoding Type. Encoding Class enumerated value (2 most significant bits): 0 = Encoded Voice; 1 = Raw Binary Data; 2 = Application-Specific Data; 3 = Database Index. Encoding Type enumerated value (14 least significant bits): 1 = 8-bit mu-law; 2 = CVSD per MIL-STD-188-113; 3 = ADPCM per CCITT G.721; 4 = 16-bit linear PCM; 5 = 8-bit linear PCM; 6 = Vector Quantization.

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

EntityID unique ID for entity within that application.

SFString [in, out] multicastRelayHost “”

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

SFInt32 [in, out] multicastRelayPort

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.

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

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.

SFBool [in, out] rtpHeaderExpected FALSE

Whether RTP headers are prepended to DIS PDUs.

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

sampleRate gives either (1) sample rate in samples per second if Encoding Class is encoded audio, or (2) data rate in bits per second for data transmissions. If Encoding Class is database index, sampleRate is set to zero.

Hint

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

Number of samples in the PDU if the Encoding Class is encoded voice, otherwise the field is set to zero.

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

Simulation/exercise siteID of the participating LAN or organization.

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

Tactical Data Link (TDL) type as an enumerated value when the Encoding Class is voice, raw binary, application-specific, or database index representation of a TDL message.

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

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

DIS