Interface SignalPdu

All Superinterfaces:
X3DBoundedObject, X3DChildNode, X3DNetworkSensorNode, X3DNode, X3DSensorNode
All Known Implementing Classes:
SignalPduObject

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.

X3D node tooltip: [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.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
See Also:
SAI Java Specification: TODO, X3D Abstract Specification: SignalPdu, X3D Tooltips: SignalPdu, X3D Scene Authoring Hints
  • Method Summary

    Modifier and Type Method Description
    java.lang.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.
    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.
    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.
    java.lang.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 X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    java.lang.String getMulticastRelayHost()
    Provide String value from inputOutput SFString field named multicastRelayHost.
    int getMulticastRelayPort()
    Provide int value from inputOutput SFInt32 field named multicastRelayPort.
    java.lang.String getNetworkMode()
    Provide String enumeration value ( baseType networkModeChoices) ["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 initializeOnly 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.
    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​(java.lang.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 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 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​(java.lang.String[] newValue)
    Accessor method to assign String array to initializeOnly MFString field named geoSystem.
    SignalPdu setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    SignalPdu setMulticastRelayHost​(java.lang.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​(java.lang.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 initializeOnly 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 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

      java.lang.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​(java.lang.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.
      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.
      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).
    • 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: 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.
      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: 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.
      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).
    • 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).
      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).
      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

      java.lang.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.
      Returns:
      value of geoSystem field
    • setGeoSystem

      SignalPdu setGeoSystem​(java.lang.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.
      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: Have we had a network update recently?.
      • 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 X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      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 X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      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

      java.lang.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​(java.lang.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

      java.lang.String getNetworkMode()
      Provide String enumeration value ( baseType networkModeChoices) ["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​(java.lang.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 initializeOnly 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 initializeOnly 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. *
      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. *
      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
    • 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).