Package org.web3d.x3d.sai.DIS

Interface TransmitterPdu

All Superinterfaces:
X3DBoundedObject, X3DChildNode, X3DNetworkSensorNode, X3DNode, X3DSensorNode
All Known Implementing Classes:
TransmitterPdu
public interface TransmitterPdu extends X3DNetworkSensorNode, X3DBoundedObject
TransmitterPdu is a networked Protocol Data Unit (PDU) information node that provides detailed information about a radio transmitter 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] TransmitterPdu is a networked Protocol Data Unit (PDU) information node that provides detailed information about a radio transmitter modeled in a simulation. Hint: TransmitterPdu 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 &lt;component name='DIS' level='1'/&gt; *


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.
    float[]
    getAntennaLocation()
    Provide array of 3-tuple float results from inputOutput SFVec3f field named antennaLocation.
    int
    getAntennaPatternLength()
    Provide int value from inputOutput SFInt32 field named antennaPatternLength.
    int
    getAntennaPatternType()
    Provide int value from inputOutput SFInt32 field named antennaPatternType.
    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
    getCryptoKeyID()
    Provide int value from inputOutput SFInt32 field named cryptoKeyID.
    int
    getCryptoSystem()
    Provide int value from inputOutput SFInt32 field named cryptoSystem.
    String
    getDescription()
    Provide String value from inputOutput SFString field named description.
    boolean
    getEnabled()
    Provide boolean value from inputOutput SFBool field named enabled.
    int
    getEntityID()
    Provide int value from inputOutput SFInt32 field named entityID.
    int
    getFrequency()
    Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named frequency.
    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.
    int
    getInputSource()
    Provide int value from inputOutput SFInt32 field named inputSource.
    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.
    int
    getLengthOfModulationParameters()
    Provide int value from inputOutput SFInt32 field named lengthOfModulationParameters.
    X3DMetadataObject
    getMetadata()
    Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
    int
    getModulationTypeDetail()
    Provide int value from inputOutput SFInt32 field named modulationTypeDetail.
    int
    getModulationTypeMajor()
    Provide int value from inputOutput SFInt32 field named modulationTypeMajor.
    int
    getModulationTypeSpreadSpectrum()
    Provide int value from inputOutput SFInt32 field named modulationTypeSpreadSpectrum.
    int
    getModulationTypeSystem()
    Provide int value from inputOutput SFInt32 field named modulationTypeSystem.
    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.
    float
    getPower()
    Provide float value from inputOutput SFFloat field named power.
    int
    getRadioEntityTypeCategory()
    Provide int value from inputOutput SFInt32 field named radioEntityTypeCategory.
    int
    getRadioEntityTypeCountry()
    Provide int value from inputOutput SFInt32 field named radioEntityTypeCountry.
    int
    getRadioEntityTypeDomain()
    Provide int value from inputOutput SFInt32 field named radioEntityTypeDomain.
    int
    getRadioEntityTypeKind()
    Provide int value from inputOutput SFInt32 field named radioEntityTypeKind.
    int
    getRadioEntityTypeNomenclature()
    Provide int value from inputOutput SFInt32 field named radioEntityTypeNomenclature.
    int
    getRadioEntityTypeNomenclatureVersion()
    Provide int value from inputOutput SFInt32 field named radioEntityTypeNomenclatureVersion.
    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[]
    getRelativeAntennaLocation()
    Provide array of 3-tuple float results from inputOutput SFVec3f field named relativeAntennaLocation.
    boolean
    getRtpHeaderExpected()
    Provide boolean value from inputOutput 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.
    float
    getTransmitFrequencyBandwidth()
    Provide float value from inputOutput SFFloat field named transmitFrequencyBandwidth.
    int
    getTransmitState()
    Provide int value from inputOutput SFInt32 field named transmitState.
    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.
    TransmitterPdu
    setAddress(String newValue)
    Accessor method to assign String value to inputOutput SFString field named address.
    TransmitterPdu
    setAntennaLocation(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named antennaLocation.
    TransmitterPdu
    setAntennaPatternLength(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named antennaPatternLength.
    TransmitterPdu
    setAntennaPatternType(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named antennaPatternType.
    TransmitterPdu
    setApplicationID(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named applicationID.
    TransmitterPdu
    setBboxCenter(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
    TransmitterPdu
    setBboxDisplay(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
    TransmitterPdu
    setBboxSize(float[] newValue)
    Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
    TransmitterPdu
    setCryptoKeyID(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named cryptoKeyID.
    TransmitterPdu
    setCryptoSystem(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named cryptoSystem.
    TransmitterPdu
    setDescription(String newValue)
    Accessor method to assign String value to inputOutput SFString field named description.
    TransmitterPdu
    setEnabled(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named enabled.
    TransmitterPdu
    setEntityID(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named entityID.
    TransmitterPdu
    setFrequency(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named frequency.
    TransmitterPdu
    setGeoCoords(double[] newValue)
    Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named geoCoords.
    TransmitterPdu
    setGeoSystem(String[] newValue)
    Accessor method to assign String array to initializeOnly MFString field named geoSystem.
    TransmitterPdu
    setInputSource(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named inputSource.
    TransmitterPdu
    setLengthOfModulationParameters(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named lengthOfModulationParameters.
    TransmitterPdu
    setMetadata(X3DMetadataObject newValue)
    Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
    TransmitterPdu
    setModulationTypeDetail(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named modulationTypeDetail.
    TransmitterPdu
    setModulationTypeMajor(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named modulationTypeMajor.
    TransmitterPdu
    setModulationTypeSpreadSpectrum(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named modulationTypeSpreadSpectrum.
    TransmitterPdu
    setModulationTypeSystem(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named modulationTypeSystem.
    TransmitterPdu
    setMulticastRelayHost(String newValue)
    Accessor method to assign String value to inputOutput SFString field named multicastRelayHost.
    TransmitterPdu
    setMulticastRelayPort(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named multicastRelayPort.
    TransmitterPdu
    setNetworkMode(String newValue)
    Accessor method to assign String enumeration value ("standAlone" | "networkReader" | "networkWriter") to inputOutput SFString field named networkMode.
    TransmitterPdu
    setPort(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named port.
    TransmitterPdu
    setPower(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named power.
    TransmitterPdu
    setRadioEntityTypeCategory(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeCategory.
    TransmitterPdu
    setRadioEntityTypeCountry(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeCountry.
    TransmitterPdu
    setRadioEntityTypeDomain(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeDomain.
    TransmitterPdu
    setRadioEntityTypeKind(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeKind.
    TransmitterPdu
    setRadioEntityTypeNomenclature(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeNomenclature.
    TransmitterPdu
    setRadioEntityTypeNomenclatureVersion(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeNomenclatureVersion.
    TransmitterPdu
    setRadioID(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named radioID.
    TransmitterPdu
    setReadInterval(double newValue)
    Accessor method to assign double value in seconds to inputOutput SFTime field named readInterval.
    TransmitterPdu
    setRelativeAntennaLocation(float[] newValue)
    Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named relativeAntennaLocation.
    TransmitterPdu
    setRtpHeaderExpected(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named rtpHeaderExpected.
    TransmitterPdu
    setSiteID(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named siteID.
    TransmitterPdu
    setTransmitFrequencyBandwidth(float newValue)
    Accessor method to assign float value to inputOutput SFFloat field named transmitFrequencyBandwidth.
    TransmitterPdu
    setTransmitState(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named transmitState.
    TransmitterPdu
    setVisible(boolean newValue)
    Accessor method to assign boolean value to inputOutput SFBool field named visible.
    TransmitterPdu
    setWhichGeometry(int newValue)
    Accessor method to assign int value to inputOutput SFInt32 field named whichGeometry.
    TransmitterPdu
    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

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

    • getAntennaLocation

      float[] getAntennaLocation()
      Provide array of 3-tuple float results from inputOutput SFVec3f field named antennaLocation.

      Tooltip: World coordinates for antenna location. *
      Returns:
      value of antennaLocation field

    • setAntennaLocation

      TransmitterPdu setAntennaLocation(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named antennaLocation.

      Tooltip: World coordinates for antenna location. *
      Parameters:
      newValue - is new value for the antennaLocation field.
      Returns:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getAntennaPatternLength

      int getAntennaPatternLength()
      Provide int value from inputOutput SFInt32 field named antennaPatternLength.

      Tooltip: . *
      Returns:
      value of antennaPatternLength field

    • setAntennaPatternLength

      TransmitterPdu setAntennaPatternLength(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named antennaPatternLength.

      Tooltip: . *
      Parameters:
      newValue - is new value for the antennaPatternLength field.
      Returns:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getAntennaPatternType

      int getAntennaPatternType()
      Provide int value from inputOutput SFInt32 field named antennaPatternType.

      Tooltip: Antenna shape pattern: 0 for omnidirectional, 1 for beam, 2 for spherical harmonic (deprecated), or optional higher value. *
      Returns:
      value of antennaPatternType field

    • setAntennaPatternType

      TransmitterPdu setAntennaPatternType(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named antennaPatternType.

      Tooltip: Antenna shape pattern: 0 for omnidirectional, 1 for beam, 2 for spherical harmonic (deprecated), or optional higher value. *
      Parameters:
      newValue - is new value for the antennaPatternType field.
      Returns:
      TransmitterPdu - 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

      TransmitterPdu 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:
      TransmitterPdu - 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/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/grouping.html#BoundingBoxes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/grouping.html#BoundingBoxes</a> Hint: X3D Architecture, 10.3.1 X3DBoundedObject <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/grouping.html#X3DBoundedObject" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/grouping.html#X3DBoundedObject</a> *
      Specified by:
      getBboxCenter in interface X3DBoundedObject
      Returns:
      value of bboxCenter field

    • setBboxCenter

      TransmitterPdu 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/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/grouping.html#BoundingBoxes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/grouping.html#BoundingBoxes</a> Hint: X3D Architecture, 10.3.1 X3DBoundedObject <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/grouping.html#X3DBoundedObject" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/grouping.html#X3DBoundedObject</a> *
      Specified by:
      setBboxCenter in interface X3DBoundedObject
      Parameters:
      newValue - is new value for the bboxCenter field.
      Returns:
      TransmitterPdu - 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

      TransmitterPdu 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:
      TransmitterPdu - 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/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/grouping.html#BoundingBoxes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/grouping.html#BoundingBoxes</a> Hint: X3D Architecture, 10.3.1 X3DBoundedObject <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/grouping.html#X3DBoundedObject" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/grouping.html#X3DBoundedObject</a> *
      Specified by:
      getBboxSize in interface X3DBoundedObject
      Returns:
      value of bboxSize field

    • setBboxSize

      TransmitterPdu 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/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/grouping.html#BoundingBoxes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/grouping.html#BoundingBoxes</a> Hint: X3D Architecture, 10.3.1 X3DBoundedObject <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/grouping.html#X3DBoundedObject" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/grouping.html#X3DBoundedObject</a> *
      Specified by:
      setBboxSize in interface X3DBoundedObject
      Parameters:
      newValue - is new value for the bboxSize field.
      Returns:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCryptoKeyID

      int getCryptoKeyID()
      Provide int value from inputOutput SFInt32 field named cryptoKeyID.

      Tooltip: Nonzero value corresponding to the simulated cryptographic key. Enumerations value 0 indicates plain (unencrypted) communications. *
      Returns:
      value of cryptoKeyID field

    • setCryptoKeyID

      TransmitterPdu setCryptoKeyID(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named cryptoKeyID.

      Tooltip: Nonzero value corresponding to the simulated cryptographic key. Enumerations value 0 indicates plain (unencrypted) communications. *
      Parameters:
      newValue - is new value for the cryptoKeyID field.
      Returns:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getCryptoSystem

      int getCryptoSystem()
      Provide int value from inputOutput SFInt32 field named cryptoSystem.

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

    • setCryptoSystem

      TransmitterPdu setCryptoSystem(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named cryptoSystem.

      Tooltip: Indicates type of crypto system being used, even if the encryption equipment is not keyed. Value 0 for No Encryption Device, higher enumerations values correspond to other specific equipment. *
      Parameters:
      newValue - is new value for the cryptoSystem field.
      Returns:
      TransmitterPdu - 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 &#38; for & ampersand character, or &#34; for " quotation-mark character). *
      Specified by:
      getDescription in interface X3DNetworkSensorNode
      Specified by:
      getDescription in interface X3DSensorNode
      Returns:
      value of description field

    • setDescription

      TransmitterPdu 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 &#38; for & ampersand character, or &#34; 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:
      TransmitterPdu - 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

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

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

    • getFrequency

      int getFrequency()
      Provide int value within allowed range of [0,infinity) from inputOutput SFInt32 field named frequency.

      Tooltip: [0,+infinity) Transmission frequency in Hz. If the radio is in frequency hopping mode, this field may be set to the center of the frequency hopping band currently in use, or to some other appropriate value. *
      Returns:
      value of frequency field

    • setFrequency

      TransmitterPdu setFrequency(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named frequency.

      Tooltip: [0,+infinity) Transmission frequency in Hz. If the radio is in frequency hopping mode, this field may be set to the center of the frequency hopping band currently in use, or to some other appropriate value. *
      Parameters:
      newValue - is new value for the frequency field.
      Returns:
      TransmitterPdu - 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 &lt;component name='Geospatial' level='1'/&gt; *
      Returns:
      value of geoCoords field

    • setGeoCoords

      TransmitterPdu 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 &lt;component name='Geospatial' level='1'/&gt; *
      Parameters:
      newValue - is new value for the geoCoords field.
      Returns:
      TransmitterPdu - 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/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#Spatialreferenceframes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#Spatialreferenceframes</a> Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#Specifyinggeospatialcoords" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//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

      TransmitterPdu 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/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#Spatialreferenceframes" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#Spatialreferenceframes</a> Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates <a href="https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/geospatial.html#Specifyinggeospatialcoords" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//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:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getInputSource

      int getInputSource()
      Provide int value from inputOutput SFInt32 field named inputSource.

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

    • setInputSource

      TransmitterPdu setInputSource(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named inputSource.

      Tooltip: Source of transmission input. Enumerations value 0 for Other, 1 for Pilot, 2 for Copilot, 3 for First Officer, 4 for Driver, 5 for Loader, 6 for Gunner, 7 for Commander, 8 for Digital Data Device, 9 for Intercom, 10 for Audio Jammer, 11 for Data Jammer, 12 for GPS Jammer, 13 for GPS Meaconer (masking beacon). *
      Parameters:
      newValue - is new value for the inputSource field.
      Returns:
      TransmitterPdu - 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

    • getLengthOfModulationParameters

      int getLengthOfModulationParameters()
      Provide int value from inputOutput SFInt32 field named lengthOfModulationParameters.

      Tooltip: . *
      Returns:
      value of lengthOfModulationParameters field

    • setLengthOfModulationParameters

      TransmitterPdu setLengthOfModulationParameters(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named lengthOfModulationParameters.

      Tooltip: . *
      Parameters:
      newValue - is new value for the lengthOfModulationParameters field.
      Returns:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • 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/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//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:

    • setMetadata

      TransmitterPdu 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/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//Part01/components/core.html#Metadata" target="_blank">https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-IS.proof//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:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:

    • getModulationTypeDetail

      int getModulationTypeDetail()
      Provide int value from inputOutput SFInt32 field named modulationTypeDetail.

      Tooltip: Integer enumeration containing detailed information depending on the major modulation type. *
      Returns:
      value of modulationTypeDetail field

    • setModulationTypeDetail

      TransmitterPdu setModulationTypeDetail(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named modulationTypeDetail.

      Tooltip: Integer enumeration containing detailed information depending on the major modulation type. *
      Parameters:
      newValue - is new value for the modulationTypeDetail field.
      Returns:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getModulationTypeMajor

      int getModulationTypeMajor()
      Provide int value from inputOutput SFInt32 field named modulationTypeMajor.

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

    • setModulationTypeMajor

      TransmitterPdu setModulationTypeMajor(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named modulationTypeMajor.

      Tooltip: Integer enumeration containing major classification of the modulation type. Enumerations value 0 for No Statement, 1 for Amplitude, 2 for Amplitude and Angle, 3 for Angle, 4 for Combination, 5 for Pulse, 6 for Unmodulated, 7 for Carrier Phase Shift Modulation (CPSM). *
      Parameters:
      newValue - is new value for the modulationTypeMajor field.
      Returns:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getModulationTypeSpreadSpectrum

      int getModulationTypeSpreadSpectrum()
      Provide int value from inputOutput SFInt32 field named modulationTypeSpreadSpectrum.

      Tooltip: Indicates the spread spectrum technique or combination of spread spectrum techniques in use. *
      Returns:
      value of modulationTypeSpreadSpectrum field

    • setModulationTypeSpreadSpectrum

      TransmitterPdu setModulationTypeSpreadSpectrum(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named modulationTypeSpreadSpectrum.

      Tooltip: Indicates the spread spectrum technique or combination of spread spectrum techniques in use. *
      Parameters:
      newValue - is new value for the modulationTypeSpreadSpectrum field.
      Returns:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getModulationTypeSystem

      int getModulationTypeSystem()
      Provide int value from inputOutput SFInt32 field named modulationTypeSystem.

      Tooltip: Specifies radio system associated with this Transmitter PDU and used to interpret other fields whose values depend on a specific radio system. *
      Returns:
      value of modulationTypeSystem field

    • setModulationTypeSystem

      TransmitterPdu setModulationTypeSystem(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named modulationTypeSystem.

      Tooltip: Specifies radio system associated with this Transmitter PDU and used to interpret other fields whose values depend on a specific radio system. *
      Parameters:
      newValue - is new value for the modulationTypeSystem field.
      Returns:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • 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

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

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

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

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

    • getPower

      float getPower()
      Provide float value from inputOutput SFFloat field named power.

      Tooltip: Power that radio would be capable of outputting if on and transmitting, independent of actual transmit state of the radio. *
      Returns:
      value of power field

    • setPower

      TransmitterPdu setPower(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named power.

      Tooltip: Power that radio would be capable of outputting if on and transmitting, independent of actual transmit state of the radio. *
      Parameters:
      newValue - is new value for the power field.
      Returns:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getRadioEntityTypeCategory

      int getRadioEntityTypeCategory()
      Provide int value from inputOutput SFInt32 field named radioEntityTypeCategory.

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

    • setRadioEntityTypeCategory

      TransmitterPdu setRadioEntityTypeCategory(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeCategory.

      Tooltip: Integer enumeration containing EntityType of transmitter radio. Enumerations value: 0 for Other, 1 for Generic Radio or Simple Intercom, 2 for HAVE QUICK, 3 for HAVE QUICK II, 4 for HAVE QUICK IIA, 5 for SINCGARS, 6 for CCTT SINCGARS, 7 for EPLRS (Enhanced Position Location Reporting System), 8 for JTIDS/MIDS, 9 for Link 11, 10 for Link 11B, 11 for L-Band SATCOM, 12 for Enhanced SINCGARS 7.3, 13 for Navigation Aid. *
      Parameters:
      newValue - is new value for the radioEntityTypeCategory field.
      Returns:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getRadioEntityTypeCountry

      int getRadioEntityTypeCountry()
      Provide int value from inputOutput SFInt32 field named radioEntityTypeCountry.

      Tooltip: Integer enumerations value for country to which the design of the entity or its design specification is attributed. *
      Returns:
      value of radioEntityTypeCountry field

    • setRadioEntityTypeCountry

      TransmitterPdu setRadioEntityTypeCountry(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeCountry.

      Tooltip: Integer enumerations value for country to which the design of the entity or its design specification is attributed. *
      Parameters:
      newValue - is new value for the radioEntityTypeCountry field.
      Returns:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getRadioEntityTypeDomain

      int getRadioEntityTypeDomain()
      Provide int value from inputOutput SFInt32 field named radioEntityTypeDomain.

      Tooltip: Integer enumerations value for domain in which the entity operates: LAND, AIR, SURFACE, SUBSURFACE, SPACE or OTHER. *
      Returns:
      value of radioEntityTypeDomain field

    • setRadioEntityTypeDomain

      TransmitterPdu setRadioEntityTypeDomain(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeDomain.

      Tooltip: Integer enumerations value for domain in which the entity operates: LAND, AIR, SURFACE, SUBSURFACE, SPACE or OTHER. *
      Parameters:
      newValue - is new value for the radioEntityTypeDomain field.
      Returns:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getRadioEntityTypeKind

      int getRadioEntityTypeKind()
      Provide int value from inputOutput SFInt32 field named radioEntityTypeKind.

      Tooltip: Integer enumerations value for whether entity is a PLATFORM, MUNITION, LIFE_FORM, ENVIRONMENTAL, CULTURAL_FEATURE, SUPPLY, RADIO, EXPENDABLE, SENSOR_EMITTER or OTHER. *
      Returns:
      value of radioEntityTypeKind field

    • setRadioEntityTypeKind

      TransmitterPdu setRadioEntityTypeKind(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeKind.

      Tooltip: Integer enumerations value for whether entity is a PLATFORM, MUNITION, LIFE_FORM, ENVIRONMENTAL, CULTURAL_FEATURE, SUPPLY, RADIO, EXPENDABLE, SENSOR_EMITTER or OTHER. *
      Parameters:
      newValue - is new value for the radioEntityTypeKind field.
      Returns:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getRadioEntityTypeNomenclature

      int getRadioEntityTypeNomenclature()
      Provide int value from inputOutput SFInt32 field named radioEntityTypeNomenclature.

      Tooltip: Integer enumerations value indicating nomenclature (name) for a particular emitter. See DIS enumerations reference for value/name pairs. *
      Returns:
      value of radioEntityTypeNomenclature field

    • setRadioEntityTypeNomenclature

      TransmitterPdu setRadioEntityTypeNomenclature(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeNomenclature.

      Tooltip: Integer enumerations value indicating nomenclature (name) for a particular emitter. See DIS enumerations reference for value/name pairs. *
      Parameters:
      newValue - is new value for the radioEntityTypeNomenclature field.
      Returns:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getRadioEntityTypeNomenclatureVersion

      int getRadioEntityTypeNomenclatureVersion()
      Provide int value from inputOutput SFInt32 field named radioEntityTypeNomenclatureVersion.

      Tooltip: Named equipment version number. *
      Returns:
      value of radioEntityTypeNomenclatureVersion field

    • setRadioEntityTypeNomenclatureVersion

      TransmitterPdu setRadioEntityTypeNomenclatureVersion(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeNomenclatureVersion.

      Tooltip: Named equipment version number. *
      Parameters:
      newValue - is new value for the radioEntityTypeNomenclatureVersion field.
      Returns:
      TransmitterPdu - 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

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

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

    • getRelativeAntennaLocation

      float[] getRelativeAntennaLocation()
      Provide array of 3-tuple float results from inputOutput SFVec3f field named relativeAntennaLocation.

      Tooltip: Relative coordinates for antenna location. *
      Returns:
      value of relativeAntennaLocation field

    • setRelativeAntennaLocation

      TransmitterPdu setRelativeAntennaLocation(float[] newValue)
      Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named relativeAntennaLocation.

      Tooltip: Relative coordinates for antenna location. *
      Parameters:
      newValue - is new value for the relativeAntennaLocation field.
      Returns:
      TransmitterPdu - 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

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

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

    • getTransmitFrequencyBandwidth

      float getTransmitFrequencyBandwidth()
      Provide float value from inputOutput SFFloat field named transmitFrequencyBandwidth.

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

    • setTransmitFrequencyBandwidth

      TransmitterPdu setTransmitFrequencyBandwidth(float newValue)
      Accessor method to assign float value to inputOutput SFFloat field named transmitFrequencyBandwidth.

      Tooltip: Bandwidth of the particular transmitter measured between the half-power (-3 dB) points (this value represents total bandwidth, not the deviation from the center frequency). *
      Parameters:
      newValue - is new value for the transmitFrequencyBandwidth field.
      Returns:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • getTransmitState

      int getTransmitState()
      Provide int value from inputOutput SFInt32 field named transmitState.

      Tooltip: Specify radio transmission state where enumerations value 0 is for off, value 1 for powered but not transmitting, or value 1 is for powered and transmitting,. *
      Returns:
      value of transmitState field

    • setTransmitState

      TransmitterPdu setTransmitState(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named transmitState.

      Tooltip: Specify radio transmission state where enumerations value 0 is for off, value 1 for powered but not transmitting, or value 1 is for powered and transmitting,. *
      Parameters:
      newValue - is new value for the transmitState field.
      Returns:
      TransmitterPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

    • 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

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

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

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