All Superinterfaces:: X3DBoundedObject, X3DChildNode, X3DNetworkSensorNode, X3DNode, X3DSensorNode

All Known Implementing Classes:: SignalPdu

public interface SignalPdu extends X3DNetworkSensorNode, X3DBoundedObject

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

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. X3D node tooltip: [X3DNetworkSensorNode,X3DBoundedObject,X3DVisibleObject] SignalPdu is a networked Protocol Data Unit (PDU) information node that communicates the transmission of voice, audio or other data modeled in a simulation. Hint: SignalPdu packets use the IEEE Distributed Interactive Simulation (DIS) protocol. Hint: Savage Developers Guide on DIS <a href="https://savage.nps.edu/Savage/developers.html#DIS" target="_blank">https://savage.nps.edu/Savage/developers.html#DIS</a> Hint: X3D for Advanced Modeling (X3D4AM) slideset <a href="https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf" target="_blank">https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf</a> Warning: requires X3D profile='Full' or else include <component name='DIS' level='1'/> *

Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).

See Also:

Method Summary

Modifier and Type

Method

Description

String

getAddress()

Provide String value from inputOutput SFString field named address.

int

getApplicationID()

Provide int value from inputOutput SFInt32 field named applicationID.

float[]

getBboxCenter()

Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.

boolean

getBboxDisplay()

Provide boolean value from inputOutput SFBool field named bboxDisplay.

float[]

getBboxSize()

Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.

int[]

getData()

Provide array of int results from inputOutput MFInt32 field named data.

int

getDataLength()

Provide int value from inputOutput SFInt32 field named dataLength.

String

getDescription()

Provide String value from inputOutput SFString field named description.

boolean

getEnabled()

Provide boolean value from inputOutput SFBool field named enabled.

int

getEncodingScheme()

Provide int value from inputOutput SFInt32 field named encodingScheme.

int

getEntityID()

Provide int value from inputOutput SFInt32 field named entityID.

double[]

getGeoCoords()

Provide array of 3-tuple double results from inputOutput SFVec3d field named geoCoords.

String[]

getGeoSystem()

Provide array of String results from initializeOnly MFString field named geoSystem.

boolean

getIsActive()

Provide boolean value from outputOnly SFBool field named isActive.

boolean

getIsNetworkReader()

Provide boolean value from outputOnly SFBool field named isNetworkReader.

boolean

getIsNetworkWriter()

Provide boolean value from outputOnly SFBool field named isNetworkWriter.

boolean

getIsRtpHeaderHeard()

Provide boolean value from outputOnly SFBool field named isRtpHeaderHeard.

boolean

getIsStandAlone()

Provide boolean value from outputOnly SFBool field named isStandAlone.

X3DMetadataObject

getMetadata()

Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.

String

getMulticastRelayHost()

Provide String value from inputOutput SFString field named multicastRelayHost.

int

getMulticastRelayPort()

Provide int value from inputOutput SFInt32 field named multicastRelayPort.

String

getNetworkMode()

Provide String enumeration value (baseType xs:NMTOKEN) ["standAlone" | "networkReader" | "networkWriter"] from inputOutput SFString field named networkMode.

int

getPort()

Provide int value from inputOutput SFInt32 field named port.

int

getRadioID()

Provide int value from inputOutput SFInt32 field named radioID.

double

getReadInterval()

Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named readInterval.

boolean

getRtpHeaderExpected()

Provide boolean value from inputOutput SFBool field named rtpHeaderExpected.

int

getSampleRate()

Provide int value from inputOutput SFInt32 field named sampleRate.

int

getSamples()

Provide int value from inputOutput SFInt32 field named samples.

int

getSiteID()

Provide int value from inputOutput SFInt32 field named siteID.

int

getTdlType()

Provide int value from inputOutput SFInt32 field named tdlType.

double

getTimestamp()

Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named timestamp.

boolean

getVisible()

Provide boolean value from inputOutput SFBool field named visible.

int

getWhichGeometry()

Provide int value from inputOutput SFInt32 field named whichGeometry.

double

getWriteInterval()

Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named writeInterval.

SignalPdu

setAddress(String newValue)

Accessor method to assign String value to inputOutput SFString field named address.

SignalPdu

setApplicationID(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named applicationID.

SignalPdu

setBboxCenter(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.

SignalPdu

setBboxDisplay(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.

SignalPdu

setBboxSize(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.

SignalPdu

setData(int[] newValue)

Accessor method to assign int array to inputOutput MFInt32 field named data.

SignalPdu

setDataLength(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named dataLength.

SignalPdu

setDescription(String newValue)

Accessor method to assign String value to inputOutput SFString field named description.

SignalPdu

setEnabled(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named enabled.

SignalPdu

setEncodingScheme(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named encodingScheme.

SignalPdu

setEntityID(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named entityID.

SignalPdu

setGeoCoords(double[] newValue)

Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named geoCoords.

SignalPdu

setGeoSystem(String[] newValue)

Accessor method to assign String array to initializeOnly MFString field named geoSystem.

SignalPdu

setMetadata(X3DMetadataObject newValue)

Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.

SignalPdu

setMulticastRelayHost(String newValue)

Accessor method to assign String value to inputOutput SFString field named multicastRelayHost.

SignalPdu

setMulticastRelayPort(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named multicastRelayPort.

SignalPdu

setNetworkMode(String newValue)

Accessor method to assign String enumeration value ("standAlone" | "networkReader" | "networkWriter") to inputOutput SFString field named networkMode.

SignalPdu

setPort(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named port.

SignalPdu

setRadioID(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named radioID.

SignalPdu

setReadInterval(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named readInterval.

SignalPdu

setRtpHeaderExpected(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named rtpHeaderExpected.

SignalPdu

setSampleRate(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named sampleRate.

SignalPdu

setSamples(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named samples.

SignalPdu

setSiteID(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named siteID.

SignalPdu

setTdlType(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named tdlType.

SignalPdu

setVisible(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named visible.

SignalPdu

setWhichGeometry(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named whichGeometry.

SignalPdu

setWriteInterval(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named writeInterval.

Method Details
- getAddress
  
  String getAddress()
  
  Provide String value from inputOutput SFString field named address.
  
  Tooltip: Multicast network address, or else 'localhost'. Example: 224.2.181.145. *
  
  Returns:
  
  value of address field
- setAddress
  
  SignalPdu setAddress(String newValue)
  
  Accessor method to assign String value to inputOutput SFString field named address.
  
  Tooltip: Multicast network address, or else 'localhost'. Example: 224.2.181.145. *
  
  Parameters:
  
  newValue - is new value for the address field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getApplicationID
  
  int getApplicationID()
  
  Provide int value from inputOutput SFInt32 field named applicationID.
  
  Tooltip: Each simulation application that can respond to simulation management PDUs needs to have a unique applicationID. *
  
  Returns:
  
  value of applicationID field
- setApplicationID
  
  SignalPdu setApplicationID(int newValue)
  
  Accessor method to assign int value to inputOutput SFInt32 field named applicationID.
  
  Tooltip: Each simulation application that can respond to simulation management PDUs needs to have a unique applicationID. *
  
  Parameters:
  
  newValue - is new value for the applicationID field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getBboxCenter
  
  float[] getBboxCenter()
  
  Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
  
  Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system. Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size. Hint: X3D Architecture, 10.2.2 Bounding boxes <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#BoundingBoxes" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#BoundingBoxes</a> Hint: X3D Architecture, 10.3.1 X3DBoundedObject <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#X3DBoundedObject" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#X3DBoundedObject</a> *
  
  Specified by:
  
  getBboxCenter in interface X3DBoundedObject
  
  Returns:
  
  value of bboxCenter field
- setBboxCenter
  
  SignalPdu setBboxCenter(float[] newValue)
  
  Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
  
  Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system. Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size. Hint: X3D Architecture, 10.2.2 Bounding boxes <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#BoundingBoxes" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#BoundingBoxes</a> Hint: X3D Architecture, 10.3.1 X3DBoundedObject <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#X3DBoundedObject" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#X3DBoundedObject</a> *
  
  Specified by:
  
  setBboxCenter in interface X3DBoundedObject
  
  Parameters:
  
  newValue - is new value for the bboxCenter field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getBboxDisplay
  
  boolean getBboxDisplay()
  
  Provide boolean value from inputOutput SFBool field named bboxDisplay.
  
  Tooltip: 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. *
  
  Specified by:
  
  getBboxDisplay in interface X3DBoundedObject
  
  Returns:
  
  value of bboxDisplay field
- setBboxDisplay
  
  SignalPdu setBboxDisplay(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
  
  Tooltip: 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. *
  
  Specified by:
  
  setBboxDisplay in interface X3DBoundedObject
  
  Parameters:
  
  newValue - is new value for the bboxDisplay field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getBboxSize
  
  float[] getBboxSize()
  
  Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
  
  Tooltip: or [0,+infinity) 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. Hint: can be useful for collision computations or inverse-kinematics (IK) engines. Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size. Hint: X3D Architecture, 10.2.2 Bounding boxes <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#BoundingBoxes" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#BoundingBoxes</a> Hint: X3D Architecture, 10.3.1 X3DBoundedObject <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#X3DBoundedObject" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#X3DBoundedObject</a> *
  
  Specified by:
  
  getBboxSize in interface X3DBoundedObject
  
  Returns:
  
  value of bboxSize field
- setBboxSize
  
  SignalPdu setBboxSize(float[] newValue)
  
  Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
  
  Tooltip: or [0,+infinity) 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. Hint: can be useful for collision computations or inverse-kinematics (IK) engines. Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size. Hint: X3D Architecture, 10.2.2 Bounding boxes <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#BoundingBoxes" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#BoundingBoxes</a> Hint: X3D Architecture, 10.3.1 X3DBoundedObject <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#X3DBoundedObject" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/grouping.html#X3DBoundedObject</a> *
  
  Specified by:
  
  setBboxSize in interface X3DBoundedObject
  
  Parameters:
  
  newValue - is new value for the bboxSize field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getData
  
  int[] getData()
  
  Provide array of int results from inputOutput MFInt32 field named data.
  
  Tooltip: Holds audio or digital data conveyed by the radio transmission. Interpretation of the field depends on values of encodingScheme and tdlType fields. *
  
  Returns:
  
  value of data field
- setData
  
  SignalPdu setData(int[] newValue)
  
  Accessor method to assign int array to inputOutput MFInt32 field named data.
  
  Tooltip: Holds audio or digital data conveyed by the radio transmission. Interpretation of the field depends on values of encodingScheme and tdlType fields. *
  
  Parameters:
  
  newValue - is new value for the data field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getDataLength
  
  int getDataLength()
  
  Provide int value from inputOutput SFInt32 field named dataLength.
  
  Tooltip: 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. *
  
  Returns:
  
  value of dataLength field
- setDataLength
  
  SignalPdu setDataLength(int newValue)
  
  Accessor method to assign int value to inputOutput SFInt32 field named dataLength.
  
  Tooltip: 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. *
  
  Parameters:
  
  newValue - is new value for the dataLength field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getDescription
  
  String getDescription()
  
  Provide String value from inputOutput SFString field named description.
  
  Tooltip: 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). *
  
  Specified by:
  
  getDescription in interface X3DNetworkSensorNode
  
  Specified by:
  
  getDescription in interface X3DSensorNode
  
  Returns:
  
  value of description field
- setDescription
  
  SignalPdu setDescription(String newValue)
  
  Accessor method to assign String value to inputOutput SFString field named description.
  
  Tooltip: 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). *
  
  Specified by:
  
  setDescription in interface X3DNetworkSensorNode
  
  Specified by:
  
  setDescription in interface X3DSensorNode
  
  Parameters:
  
  newValue - is new value for the description field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getEnabled
  
  boolean getEnabled()
  
  Provide boolean value from inputOutput SFBool field named enabled.
  
  Tooltip: Enables/disables the sensor node. *
  
  Specified by:
  
  getEnabled in interface X3DNetworkSensorNode
  
  Specified by:
  
  getEnabled in interface X3DSensorNode
  
  Returns:
  
  value of enabled field
- setEnabled
  
  SignalPdu setEnabled(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named enabled.
  
  Tooltip: Enables/disables the sensor node. *
  
  Specified by:
  
  setEnabled in interface X3DNetworkSensorNode
  
  Specified by:
  
  setEnabled in interface X3DSensorNode
  
  Parameters:
  
  newValue - is new value for the enabled field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getEncodingScheme
  
  int getEncodingScheme()
  
  Provide int value from inputOutput SFInt32 field named encodingScheme.
  
  Tooltip: 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. *
  
  Returns:
  
  value of encodingScheme field
- setEncodingScheme
  
  SignalPdu setEncodingScheme(int newValue)
  
  Accessor method to assign int value to inputOutput SFInt32 field named encodingScheme.
  
  Tooltip: 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. *
  
  Parameters:
  
  newValue - is new value for the encodingScheme field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getEntityID
  
  int getEntityID()
  
  Provide int value from inputOutput SFInt32 field named entityID.
  
  Tooltip: EntityID unique ID for entity within that application. *
  
  Returns:
  
  value of entityID field
- setEntityID
  
  SignalPdu setEntityID(int newValue)
  
  Accessor method to assign int value to inputOutput SFInt32 field named entityID.
  
  Tooltip: EntityID unique ID for entity within that application. *
  
  Parameters:
  
  newValue - is new value for the entityID field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getGeoCoords
  
  double[] getGeoCoords()
  
  Provide array of 3-tuple double results from inputOutput SFVec3d field named geoCoords.
  
  Tooltip: Geographic location (specified in current geoSystem coordinates) for children geometry (specified in relative coordinate system, in meters). Hint: X3D for Advanced Modeling (X3D4AM) slideset <a href="https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf" target="_blank">https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf</a> Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/> *
  
  Returns:
  
  value of geoCoords field
- setGeoCoords
  
  SignalPdu setGeoCoords(double[] newValue)
  
  Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named geoCoords.
  
  Tooltip: Geographic location (specified in current geoSystem coordinates) for children geometry (specified in relative coordinate system, in meters). Hint: X3D for Advanced Modeling (X3D4AM) slideset <a href="https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf" target="_blank">https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf</a> Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/> *
  
  Parameters:
  
  newValue - is new value for the geoCoords field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getGeoSystem
  
  String[] getGeoSystem()
  
  Provide array of String results from initializeOnly MFString field named geoSystem.
  
  Tooltip: 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. Hint: X3D Architecture 25.2.2 Spatial reference frames <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/geospatial.html#Spatialreferenceframes" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/geospatial.html#Spatialreferenceframes</a> Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/geospatial.html#Specifyinggeospatialcoords" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/geospatial.html#Specifyinggeospatialcoords</a> Hint: UTM is Universal Transverse Mercator coordinate system <a href="https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system" target="_blank">https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system</a> Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). *
  
  Returns:
  
  value of geoSystem field
- setGeoSystem
  
  SignalPdu setGeoSystem(String[] newValue)
  
  Accessor method to assign String array to initializeOnly MFString field named geoSystem.
  
  Tooltip: 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. Hint: X3D Architecture 25.2.2 Spatial reference frames <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/geospatial.html#Spatialreferenceframes" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/geospatial.html#Spatialreferenceframes</a> Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/geospatial.html#Specifyinggeospatialcoords" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/geospatial.html#Specifyinggeospatialcoords</a> Hint: UTM is Universal Transverse Mercator coordinate system <a href="https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system" target="_blank">https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system</a> Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC). *
  
  Parameters:
  
  newValue - is new value for the geoSystem field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getIsActive
  
  boolean getIsActive()
  
  Provide boolean value from outputOnly SFBool field named isActive.
  
  Tooltip: 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. *
  
  Specified by:
  
  getIsActive in interface X3DNetworkSensorNode
  
  Specified by:
  
  getIsActive in interface X3DSensorNode
  
  Returns:
  
  value of isActive field
- getIsNetworkReader
  
  boolean getIsNetworkReader()
  
  Provide boolean value from outputOnly SFBool field named isNetworkReader.
  
  Tooltip: 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. *
  
  Returns:
  
  value of isNetworkReader field
- getIsNetworkWriter
  
  boolean getIsNetworkWriter()
  
  Provide boolean value from outputOnly SFBool field named isNetworkWriter.
  
  Tooltip: 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. *
  
  Returns:
  
  value of isNetworkWriter field
- getIsRtpHeaderHeard
  
  boolean getIsRtpHeaderHeard()
  
  Provide boolean value from outputOnly SFBool field named isRtpHeaderHeard.
  
  Tooltip: 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. *
  
  Returns:
  
  value of isRtpHeaderHeard field
- getIsStandAlone
  
  boolean getIsStandAlone()
  
  Provide boolean value from outputOnly SFBool field named isStandAlone.
  
  Tooltip: 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. *
  
  Returns:
  
  value of isStandAlone field
- getMetadata
  X3DMetadataObject getMetadata()
  
  Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata</a> *
  
  Specified by:
  
  getMetadata in interface X3DChildNode
  
  Specified by:
  
  getMetadata in interface X3DNetworkSensorNode
  
  Specified by:
  
  getMetadata in interface X3DNode
  
  Specified by:
  
  getMetadata in interface X3DSensorNode
  
  Returns:
  
  value of metadata field
  
  See Also:
  
  X3D Scene Authoring Hints: Metadata Nodes
- setMetadata
  SignalPdu setMetadata(X3DMetadataObject newValue)
  
  Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node. Hint: X3D Architecture 7.2.4 Metadata <a href="https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS//Part01/components/core.html#Metadata</a> *
  
  Specified by:
  
  setMetadata in interface X3DChildNode
  
  Specified by:
  
  setMetadata in interface X3DNetworkSensorNode
  
  Specified by:
  
  setMetadata in interface X3DNode
  
  Specified by:
  
  setMetadata in interface X3DSensorNode
  
  Parameters:
  
  newValue - is new value for the metadata field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
  
  See Also:
  
  X3D Scene Authoring Hints: Metadata Nodes
- getMulticastRelayHost
  
  String getMulticastRelayHost()
  
  Provide String value from inputOutput SFString field named multicastRelayHost.
  
  Tooltip: Fallback server address if multicast not available locally. For example: track.nps.edu. *
  
  Returns:
  
  value of multicastRelayHost field
- setMulticastRelayHost
  
  SignalPdu setMulticastRelayHost(String newValue)
  
  Accessor method to assign String value to inputOutput SFString field named multicastRelayHost.
  
  Tooltip: Fallback server address if multicast not available locally. For example: track.nps.edu. *
  
  Parameters:
  
  newValue - is new value for the multicastRelayHost field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getMulticastRelayPort
  
  int getMulticastRelayPort()
  
  Provide int value from inputOutput SFInt32 field named multicastRelayPort.
  
  Tooltip: Fallback server port if multicast not available locally. For example: 8010. *
  
  Returns:
  
  value of multicastRelayPort field
- setMulticastRelayPort
  
  SignalPdu setMulticastRelayPort(int newValue)
  
  Accessor method to assign int value to inputOutput SFInt32 field named multicastRelayPort.
  
  Tooltip: Fallback server port if multicast not available locally. For example: 8010. *
  
  Parameters:
  
  newValue - is new value for the multicastRelayPort field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getNetworkMode
  
  String getNetworkMode()
  
  Provide String enumeration value (baseType xs:NMTOKEN) ["standAlone" | "networkReader" | "networkWriter"] from inputOutput SFString field named networkMode.
  
  Tooltip: 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. Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values. Warning: network activity may have associated security issues. *
  
  Returns:
  
  value of networkMode field
- setNetworkMode
  
  SignalPdu setNetworkMode(String newValue)
  
  Accessor method to assign String enumeration value ("standAlone" | "networkReader" | "networkWriter") to inputOutput SFString field named networkMode.
  
  Tooltip: 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. Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values. Warning: network activity may have associated security issues. *
  
  Parameters:
  
  newValue - is new value for the networkMode field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getPort
  
  int getPort()
  
  Provide int value from inputOutput SFInt32 field named port.
  
  Tooltip: Multicast network port, for example: 3000. *
  
  Returns:
  
  value of port field
- setPort
  
  SignalPdu setPort(int newValue)
  
  Accessor method to assign int value to inputOutput SFInt32 field named port.
  
  Tooltip: Multicast network port, for example: 3000. *
  
  Parameters:
  
  newValue - is new value for the port field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getRadioID
  
  int getRadioID()
  
  Provide int value from inputOutput SFInt32 field named radioID.
  
  Tooltip: Identifies a particular radio within a given entity. *
  
  Returns:
  
  value of radioID field
- setRadioID
  
  SignalPdu setRadioID(int newValue)
  
  Accessor method to assign int value to inputOutput SFInt32 field named radioID.
  
  Tooltip: Identifies a particular radio within a given entity. *
  
  Parameters:
  
  newValue - is new value for the radioID field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getReadInterval
  
  double getReadInterval()
  
  Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named readInterval.
  
  Tooltip: [0,+infinity) Seconds between read updates, 0 means no reading. Hint: readInterval is a nonnegative SFTime duration interval, not an absolute clock time. *
  
  Returns:
  
  value of readInterval field
- setReadInterval
  
  SignalPdu setReadInterval(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named readInterval.
  
  Tooltip: [0,+infinity) Seconds between read updates, 0 means no reading. Hint: readInterval is a nonnegative SFTime duration interval, not an absolute clock time. *
  
  Parameters:
  
  newValue - is new value for the readInterval field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getRtpHeaderExpected
  
  boolean getRtpHeaderExpected()
  
  Provide boolean value from inputOutput SFBool field named rtpHeaderExpected.
  
  Tooltip: Whether RTP headers are prepended to DIS PDUs. *
  
  Returns:
  
  value of rtpHeaderExpected field
- setRtpHeaderExpected
  
  SignalPdu setRtpHeaderExpected(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named rtpHeaderExpected.
  
  Tooltip: Whether RTP headers are prepended to DIS PDUs. *
  
  Parameters:
  
  newValue - is new value for the rtpHeaderExpected field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getSampleRate
  
  int getSampleRate()
  
  Provide int value from inputOutput SFInt32 field named sampleRate.
  
  Tooltip: 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: Wikipedia Nyquist frequency <a href="https://en.wikipedia.org/wiki/Nyquist_frequency" target="_blank">https://en.wikipedia.org/wiki/Nyquist_frequency</a> *
  
  Returns:
  
  value of sampleRate field
- setSampleRate
  
  SignalPdu setSampleRate(int newValue)
  
  Accessor method to assign int value to inputOutput SFInt32 field named sampleRate.
  
  Tooltip: 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: Wikipedia Nyquist frequency <a href="https://en.wikipedia.org/wiki/Nyquist_frequency" target="_blank">https://en.wikipedia.org/wiki/Nyquist_frequency</a> *
  
  Parameters:
  
  newValue - is new value for the sampleRate field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getSamples
  
  int getSamples()
  
  Provide int value from inputOutput SFInt32 field named samples.
  
  Tooltip: Number of samples in the PDU if the Encoding Class is encoded voice, otherwise the field is set to zero. *
  
  Returns:
  
  value of samples field
- setSamples
  
  SignalPdu setSamples(int newValue)
  
  Accessor method to assign int value to inputOutput SFInt32 field named samples.
  
  Tooltip: Number of samples in the PDU if the Encoding Class is encoded voice, otherwise the field is set to zero. *
  
  Parameters:
  
  newValue - is new value for the samples field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getSiteID
  
  int getSiteID()
  
  Provide int value from inputOutput SFInt32 field named siteID.
  
  Tooltip: Simulation/exercise siteID of the participating LAN or organization. *
  
  Returns:
  
  value of siteID field
- setSiteID
  
  SignalPdu setSiteID(int newValue)
  
  Accessor method to assign int value to inputOutput SFInt32 field named siteID.
  
  Tooltip: Simulation/exercise siteID of the participating LAN or organization. *
  
  Parameters:
  
  newValue - is new value for the siteID field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getTdlType
  
  int getTdlType()
  
  Provide int value from inputOutput SFInt32 field named tdlType.
  
  Tooltip: 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. *
  
  Returns:
  
  value of tdlType field
- setTdlType
  
  SignalPdu setTdlType(int newValue)
  
  Accessor method to assign int value to inputOutput SFInt32 field named tdlType.
  
  Tooltip: 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. *
  
  Parameters:
  
  newValue - is new value for the tdlType field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getTimestamp
  
  double getTimestamp()
  
  Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named timestamp.
  
  Tooltip: 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. *
  
  Returns:
  
  value of timestamp field
- getVisible
  
  boolean getVisible()
  
  Provide boolean value from inputOutput SFBool field named visible.
  
  Tooltip: Whether or not renderable content within this node is visually displayed. Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics. Hint: content must be visible to be collidable and to be pickable. *
  
  Specified by:
  
  getVisible in interface X3DBoundedObject
  
  Returns:
  
  value of visible field
- setVisible
  
  SignalPdu setVisible(boolean newValue)
  
  Accessor method to assign boolean value to inputOutput SFBool field named visible.
  
  Tooltip: Whether or not renderable content within this node is visually displayed. Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics. Hint: content must be visible to be collidable and to be pickable. *
  
  Specified by:
  
  setVisible in interface X3DBoundedObject
  
  Parameters:
  
  newValue - is new value for the visible field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getWhichGeometry
  
  int getWhichGeometry()
  
  Provide int value from inputOutput SFInt32 field named whichGeometry.
  
  Tooltip: Select geometry to render: -1 for no geometry, 0 for text trace, 1 for default geometry, (optional) higher values to render different states. *
  
  Returns:
  
  value of whichGeometry field
- setWhichGeometry
  
  SignalPdu setWhichGeometry(int newValue)
  
  Accessor method to assign int value to inputOutput SFInt32 field named whichGeometry.
  
  Tooltip: Select geometry to render: -1 for no geometry, 0 for text trace, 1 for default geometry, (optional) higher values to render different states. *
  
  Parameters:
  
  newValue - is new value for the whichGeometry field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
- getWriteInterval
  
  double getWriteInterval()
  
  Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named writeInterval.
  
  Tooltip: [0,+infinity) Seconds between write updates, 0 means no writing (sending). Hint: writeInterval is a nonnegative SFTime duration interval, not an absolute clock time. *
  
  Returns:
  
  value of writeInterval field
- setWriteInterval
  
  SignalPdu setWriteInterval(double newValue)
  
  Accessor method to assign double value in seconds to inputOutput SFTime field named writeInterval.
  
  Tooltip: [0,+infinity) Seconds between write updates, 0 means no writing (sending). Hint: writeInterval is a nonnegative SFTime duration interval, not an absolute clock time. *
  
  Parameters:
  
  newValue - is new value for the writeInterval field.
  
  Returns:
  
  SignalPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

Interface SignalPdu

Method Summary

Method Details

getAddress

setAddress

getApplicationID

setApplicationID

getBboxCenter

setBboxCenter

getBboxDisplay

setBboxDisplay

getBboxSize

setBboxSize

getData

setData

getDataLength

setDataLength

getDescription

setDescription

getEnabled

setEnabled

getEncodingScheme

setEncodingScheme

getEntityID

setEntityID

getGeoCoords

setGeoCoords

getGeoSystem

setGeoSystem

getIsActive

getIsNetworkReader

getIsNetworkWriter

getIsRtpHeaderHeard

getIsStandAlone

getMetadata

setMetadata

getMulticastRelayHost

setMulticastRelayHost

getMulticastRelayPort

setMulticastRelayPort

getNetworkMode

setNetworkMode

getPort

setPort

getRadioID

setRadioID

getReadInterval

setReadInterval

getRtpHeaderExpected

setRtpHeaderExpected

getSampleRate

setSampleRate

getSamples

setSamples

getSiteID

setSiteID

getTdlType

setTdlType

getTimestamp

getVisible

setVisible

getWhichGeometry

setWhichGeometry

getWriteInterval

setWriteInterval