Interface ReceiverPdu

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

public interface ReceiverPdu
extends X3DNetworkSensorNode, X3DBoundedObject
ReceiverPdu is a networked Protocol Data Unit (PDU) information node that transmits the state of radio frequency (RF) receivers modeled in a simulation.

X3D node tooltip: [X3DNetworkSensorNode,X3DBoundedObject] ReceiverPdu is a networked Protocol Data Unit (PDU) information node that transmits the state of radio frequency (RF) receivers 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: ReceiverPdu, X3D Tooltips: ReceiverPdu, 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.
    boolean getEnabled()
    Provide boolean value from inputOutput SFBool field named enabled.
    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.
    float getReceivedPower()
    Provide float value from inputOutput SFFloat field named receivedPower.
    int getReceiverState()
    Provide int value from inputOutput SFInt32 field named receiverState.
    boolean getRtpHeaderExpected()
    Provide boolean value from initializeOnly SFBool field named rtpHeaderExpected.
    int getSiteID()
    Provide int value from inputOutput SFInt32 field named siteID.
    double getTimestamp()
    Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named timestamp.
    int getTransmitterApplicationID()
    Provide int value from inputOutput SFInt32 field named transmitterApplicationID.
    int getTransmitterEntityID()
    Provide int value from inputOutput SFInt32 field named transmitterEntityID.
    int getTransmitterRadioID()
    Provide int value from inputOutput SFInt32 field named transmitterRadioID.
    int getTransmitterSiteID()
    Provide int value from inputOutput SFInt32 field named transmitterSiteID.
    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.
    ReceiverPdu setAddress​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named address.
    ReceiverPdu setApplicationID​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named applicationID.
    ReceiverPdu setBboxCenter​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
    ReceiverPdu setBboxSize​(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
    ReceiverPdu setEnabled​(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    ReceiverPdu setEntityID​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named entityID.
    ReceiverPdu setGeoCoords​(double[] newValue)
    Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named geoCoords.
    ReceiverPdu setGeoSystem​(java.lang.String[] newValue)
    Accessor method to assign String array to initializeOnly MFString field named geoSystem.
    ReceiverPdu setMetadata​(X3DMetadataObject newValue)
    Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    ReceiverPdu setMulticastRelayHost​(java.lang.String newValue)
    Accessor method to assign String value to inputOutput SFString field named multicastRelayHost.
    ReceiverPdu setMulticastRelayPort​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named multicastRelayPort.
    ReceiverPdu setNetworkMode​(java.lang.String newValue)
    Accessor method to assign String enumeration value ("standAlone" | "networkReader" | "networkWriter") to inputOutput SFString field named networkMode.
    ReceiverPdu setPort​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named port.
    ReceiverPdu setRadioID​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named radioID.
    ReceiverPdu setReadInterval​(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named readInterval.
    ReceiverPdu setReceivedPower​(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named receivedPower.
    ReceiverPdu setReceiverState​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named receiverState.
    ReceiverPdu setRtpHeaderExpected​(boolean newValue)
    Accessor method to assign boolean value to initializeOnly SFBool field named rtpHeaderExpected.
    ReceiverPdu setSiteID​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named siteID.
    ReceiverPdu setTransmitterApplicationID​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named transmitterApplicationID.
    ReceiverPdu setTransmitterEntityID​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named transmitterEntityID.
    ReceiverPdu setTransmitterRadioID​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named transmitterRadioID.
    ReceiverPdu setTransmitterSiteID​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named transmitterSiteID.
    ReceiverPdu setWhichGeometry​(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named whichGeometry.
    ReceiverPdu 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

      ReceiverPdu 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:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getReceivedPower

      float getReceivedPower()
      Provide float value from inputOutput SFFloat field named receivedPower.

      Tooltip: receivedPower indicates radio frequency (RF) power received, in units of decibel-milliwatts (dBm), after applying any propagation loss and antenna gain. *
      Returns:
      value of receivedPower field
    • setReceivedPower

      ReceiverPdu setReceivedPower​(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named receivedPower.

      Tooltip: receivedPower indicates radio frequency (RF) power received, in units of decibel-milliwatts (dBm), after applying any propagation loss and antenna gain. *
      Parameters:
      newValue - is new value for the receivedPower field.
      Returns:
      ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getReceiverState

      int getReceiverState()
      Provide int value from inputOutput SFInt32 field named receiverState.

      Tooltip: receiverState indicates if receiver is currently idle or busy via one of these enumerated values: 0 = off, 1 = on but not receiving, or 2 = on and receiving. *
      Returns:
      value of receiverState field
    • setReceiverState

      ReceiverPdu setReceiverState​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named receiverState.

      Tooltip: receiverState indicates if receiver is currently idle or busy via one of these enumerated values: 0 = off, 1 = on but not receiving, or 2 = on and receiving. *
      Parameters:
      newValue - is new value for the receiverState field.
      Returns:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - 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
    • getTransmitterApplicationID

      int getTransmitterApplicationID()
      Provide int value from inputOutput SFInt32 field named transmitterApplicationID.

      Tooltip: Simulation/exercise transmitterApplicationID is unique for transmitter application at that site. Each simulation application that can respond to simulation management PDUs needs to have a unique applicationID. *
      Returns:
      value of transmitterApplicationID field
    • setTransmitterApplicationID

      ReceiverPdu setTransmitterApplicationID​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named transmitterApplicationID.

      Tooltip: Simulation/exercise transmitterApplicationID is unique for transmitter application at that site. Each simulation application that can respond to simulation management PDUs needs to have a unique applicationID. *
      Parameters:
      newValue - is new value for the transmitterApplicationID field.
      Returns:
      ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getTransmitterEntityID

      int getTransmitterEntityID()
      Provide int value from inputOutput SFInt32 field named transmitterEntityID.

      Tooltip: Simulation/exercise transmitterEntityID is a unique ID for a single entity within that application. *
      Returns:
      value of transmitterEntityID field
    • setTransmitterEntityID

      ReceiverPdu setTransmitterEntityID​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named transmitterEntityID.

      Tooltip: Simulation/exercise transmitterEntityID is a unique ID for a single entity within that application. *
      Parameters:
      newValue - is new value for the transmitterEntityID field.
      Returns:
      ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getTransmitterRadioID

      int getTransmitterRadioID()
      Provide int value from inputOutput SFInt32 field named transmitterRadioID.

      Tooltip: Identifies a particular radio within a given entity. *
      Returns:
      value of transmitterRadioID field
    • setTransmitterRadioID

      ReceiverPdu setTransmitterRadioID​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named transmitterRadioID.

      Tooltip: Identifies a particular radio within a given entity. *
      Parameters:
      newValue - is new value for the transmitterRadioID field.
      Returns:
      ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getTransmitterSiteID

      int getTransmitterSiteID()
      Provide int value from inputOutput SFInt32 field named transmitterSiteID.

      Tooltip: Simulation/exercise transmitterSiteID of the participating LAN or organization. *
      Returns:
      value of transmitterSiteID field
    • setTransmitterSiteID

      ReceiverPdu setTransmitterSiteID​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named transmitterSiteID.

      Tooltip: Simulation/exercise transmitterSiteID of the participating LAN or organization. *
      Parameters:
      newValue - is new value for the transmitterSiteID field.
      Returns:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - 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

      ReceiverPdu 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:
      ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).