Class TransmitterPduObject

java.lang.Object
All Implemented Interfaces:
X3DChildNode, X3DNode, X3DSensorNode, TransmitterPdu, X3DBoundedObject, X3DNetworkSensorNode

public class TransmitterPduObject
extends X3DConcreteNode
implements TransmitterPdu
TransmitterPdu is a networked Protocol Data Unit (PDU) information node that provides detailed information about a radio transmitter modeled in a simulation.

X3D node tooltip: [X3DNetworkSensorNode,X3DBoundedObject] TransmitterPdu is a networked Protocol Data Unit (PDU) information node that provides detailed information about a radio transmitter modeled in a simulation.
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
See Also:
X3D Abstract Specification: TransmitterPdu, X3D Tooltips: TransmitterPdu, X3D Scene Authoring Hints
  • Field Details

  • Constructor Details

    • TransmitterPduObject

      public TransmitterPduObject()
      Constructor for TransmitterPduObject to initialize member variables with default values.
    • TransmitterPduObject

      public TransmitterPduObject​(java.lang.String DEFlabel)
      Utility constructor that assigns DEF label after initializing member variables with default values.
      Parameters:
      DEFlabel - unique DEF name for this X3D node
  • Method Details

    • getElementName

      public final java.lang.String getElementName()
      Provides name of this element: TransmitterPdu
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the TransmitterPdu element: DIS
      Specified by:
      getComponent in class X3DConcreteElement
      Returns:
      X3D component for this element
    • getComponentLevel

      public final int getComponentLevel()
      Provides default X3D component level for this element: 1
      Specified by:
      getComponentLevel in class X3DConcreteElement
      Returns:
      default X3D component level for this element
    • getFieldType

      public java.lang.String getFieldType​(java.lang.String fieldName)
      Indicate type corresponding to given fieldName.
      Specified by:
      getFieldType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
    • getAccessType

      public java.lang.String getAccessType​(java.lang.String fieldName)
      Indicate accessType corresponding to given fieldName.
      Specified by:
      getAccessType in class X3DConcreteElement
      Parameters:
      fieldName - name of field in this X3D node
      Returns:
      X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
      See Also:
      ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
    • getContainerFieldDefault

      public final java.lang.String getContainerFieldDefault()
      containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.
      Specified by:
      getContainerFieldDefault in class X3DConcreteNode
      Returns:
      default containerField value
      See Also:
      X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
    • initialize

      public final void initialize()
      Initialize all member variables to default values.
      Overrides:
      initialize in class X3DConcreteNode
    • getAddress

      public 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. *
      Specified by:
      getAddress in interface TransmitterPdu
      Returns:
      value of address field
    • setAddress

      public TransmitterPduObject 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. *
      Specified by:
      setAddress in interface TransmitterPdu
      Parameters:
      newValue - is new value for the address field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAddress

      public TransmitterPduObject setAddress​(SFStringObject newValue)
      Assign typed object value to SFString address field, similar to setAddress(String).
      Parameters:
      newValue - is new value for the address field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getAntennaLocation

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

      Tooltip: World coordinates for antenna location. *
      Specified by:
      getAntennaLocation in interface TransmitterPdu
      Returns:
      value of antennaLocation field
    • setAntennaLocation

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

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

      public TransmitterPduObject setAntennaLocation​(SFVec3fObject newValue)
      Assign typed object value to SFVec3f antennaLocation field, similar to setAntennaLocation(float[]).
      Parameters:
      newValue - is new value for the antennaLocation field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAntennaLocation

      public TransmitterPduObject setAntennaLocation​(float x, float y, float z)
      Assign values to SFVec3f antennaLocation field, similar to setAntennaLocation(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAntennaLocation

      public TransmitterPduObject setAntennaLocation​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setAntennaLocation(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAntennaLocation

      public TransmitterPduObject setAntennaLocation​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setAntennaLocation(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getAntennaPatternLength

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

      Tooltip: . *
      Specified by:
      getAntennaPatternLength in interface TransmitterPdu
      Returns:
      value of antennaPatternLength field
    • setAntennaPatternLength

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

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

      public TransmitterPduObject setAntennaPatternLength​(SFInt32Object newValue)
      Assign typed object value to SFInt32 antennaPatternLength field, similar to setAntennaPatternLength(int).
      Parameters:
      newValue - is new value for the antennaPatternLength field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getAntennaPatternType

      public 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. *
      Specified by:
      getAntennaPatternType in interface TransmitterPdu
      Returns:
      value of antennaPatternType field
    • setAntennaPatternType

      public TransmitterPduObject 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. *
      Specified by:
      setAntennaPatternType in interface TransmitterPdu
      Parameters:
      newValue - is new value for the antennaPatternType field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setAntennaPatternType

      public TransmitterPduObject setAntennaPatternType​(SFInt32Object newValue)
      Assign typed object value to SFInt32 antennaPatternType field, similar to setAntennaPatternType(int).
      Parameters:
      newValue - is new value for the antennaPatternType field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getApplicationID

      public 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. *
      Specified by:
      getApplicationID in interface TransmitterPdu
      Returns:
      value of applicationID field
    • setApplicationID

      public TransmitterPduObject 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. *
      Specified by:
      setApplicationID in interface TransmitterPdu
      Parameters:
      newValue - is new value for the applicationID field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setApplicationID

      public TransmitterPduObject setApplicationID​(SFInt32Object newValue)
      Assign typed object value to SFInt32 applicationID field, similar to setApplicationID(int).
      Parameters:
      newValue - is new value for the applicationID field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getBboxCenter

      public 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 TransmitterPdu
      Specified by:
      getBboxCenter in interface X3DBoundedObject
      Returns:
      value of bboxCenter field
    • setBboxCenter

      public TransmitterPduObject 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 TransmitterPdu
      Specified by:
      setBboxCenter in interface X3DBoundedObject
      Parameters:
      newValue - is new value for the bboxCenter field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public TransmitterPduObject setBboxCenter​(SFVec3fObject newValue)
      Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
      Parameters:
      newValue - is new value for the bboxCenter field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public TransmitterPduObject setBboxCenter​(float x, float y, float z)
      Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public TransmitterPduObject setBboxCenter​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxCenter

      public TransmitterPduObject setBboxCenter​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getBboxSize

      public 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 TransmitterPdu
      Specified by:
      getBboxSize in interface X3DBoundedObject
      Returns:
      value of bboxSize field
    • setBboxSize

      public TransmitterPduObject 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 TransmitterPdu
      Specified by:
      setBboxSize in interface X3DBoundedObject
      Parameters:
      newValue - is new value for the bboxSize field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

      public TransmitterPduObject setBboxSize​(SFVec3fObject newValue)
      Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
      Parameters:
      newValue - is new value for the bboxSize field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

      public TransmitterPduObject setBboxSize​(float x, float y, float z)
      Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

      public TransmitterPduObject setBboxSize​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setBboxSize

      public TransmitterPduObject setBboxSize​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCryptoKeyID

      public 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. *
      Specified by:
      getCryptoKeyID in interface TransmitterPdu
      Returns:
      value of cryptoKeyID field
    • setCryptoKeyID

      public TransmitterPduObject 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. *
      Specified by:
      setCryptoKeyID in interface TransmitterPdu
      Parameters:
      newValue - is new value for the cryptoKeyID field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCryptoKeyID

      public TransmitterPduObject setCryptoKeyID​(SFInt32Object newValue)
      Assign typed object value to SFInt32 cryptoKeyID field, similar to setCryptoKeyID(int).
      Parameters:
      newValue - is new value for the cryptoKeyID field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCryptoSystem

      public 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.. *
      Specified by:
      getCryptoSystem in interface TransmitterPdu
      Returns:
      value of cryptoSystem field
    • setCryptoSystem

      public TransmitterPduObject 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.. *
      Specified by:
      setCryptoSystem in interface TransmitterPdu
      Parameters:
      newValue - is new value for the cryptoSystem field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setCryptoSystem

      public TransmitterPduObject setCryptoSystem​(SFInt32Object newValue)
      Assign typed object value to SFInt32 cryptoSystem field, similar to setCryptoSystem(int).
      Parameters:
      newValue - is new value for the cryptoSystem field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getEnabled

      public boolean getEnabled()
      Provide boolean value from inputOutput SFBool field named enabled.

      Tooltip: Enables/disables the sensor node. *
      Specified by:
      getEnabled in interface TransmitterPdu
      Specified by:
      getEnabled in interface X3DNetworkSensorNode
      Specified by:
      getEnabled in interface X3DSensorNode
      Returns:
      value of enabled field
    • setEnabled

      public TransmitterPduObject 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 TransmitterPdu
      Specified by:
      setEnabled in interface X3DNetworkSensorNode
      Specified by:
      setEnabled in interface X3DSensorNode
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setEnabled

      public TransmitterPduObject setEnabled​(SFBoolObject newValue)
      Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
      Parameters:
      newValue - is new value for the enabled field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getEntityID

      public int getEntityID()
      Provide int value from inputOutput SFInt32 field named entityID.

      Tooltip: EntityID unique ID for entity within that application. *
      Specified by:
      getEntityID in interface TransmitterPdu
      Returns:
      value of entityID field
    • setEntityID

      public TransmitterPduObject setEntityID​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named entityID.

      Tooltip: EntityID unique ID for entity within that application. *
      Specified by:
      setEntityID in interface TransmitterPdu
      Parameters:
      newValue - is new value for the entityID field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setEntityID

      public TransmitterPduObject setEntityID​(SFInt32Object newValue)
      Assign typed object value to SFInt32 entityID field, similar to setEntityID(int).
      Parameters:
      newValue - is new value for the entityID field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getFrequency

      public int getFrequency()
      Provide int value from inputOutput SFInt32 field named frequency.

      Tooltip: 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. *
      Specified by:
      getFrequency in interface TransmitterPdu
      Returns:
      value of frequency field
    • setFrequency

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

      Tooltip: 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. *
      Specified by:
      setFrequency in interface TransmitterPdu
      Parameters:
      newValue - is new value for the frequency field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setFrequency

      public TransmitterPduObject setFrequency​(SFInt32Object newValue)
      Assign typed object value to SFInt32 frequency field, similar to setFrequency(int).
      Parameters:
      newValue - is new value for the frequency field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getGeoCoords

      public 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).
      Specified by:
      getGeoCoords in interface TransmitterPdu
      Returns:
      value of geoCoords field
    • setGeoCoords

      public TransmitterPduObject 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).
      Specified by:
      setGeoCoords in interface TransmitterPdu
      Parameters:
      newValue - is new value for the geoCoords field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGeoCoords

      public TransmitterPduObject setGeoCoords​(SFVec3dObject newValue)
      Assign typed object value to SFVec3d geoCoords field, similar to setGeoCoords(double[]).
      Parameters:
      newValue - is new value for the geoCoords field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGeoCoords

      public TransmitterPduObject setGeoCoords​(double x, double y, double z)
      Assign values to SFVec3d geoCoords field, similar to setGeoCoords(double[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getGeoSystem

      public 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.
      Specified by:
      getGeoSystem in interface TransmitterPdu
      Returns:
      value of geoSystem field
    • getGeoSystemList

      public java.util.ArrayList<java.lang.String> getGeoSystemList()
      Utility method to get ArrayList value of MFString geoSystem field, similar to getGeoSystem().
      Returns:
      value of geoSystem field
    • setGeoSystem

      public TransmitterPduObject 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.
      Specified by:
      setGeoSystem in interface TransmitterPdu
      Parameters:
      newValue - is new value for the geoSystem field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGeoSystem

      public TransmitterPduObject setGeoSystem​(MFStringObject newValue)
      Assign typed object value to MFString geoSystem field, similar to setGeoSystem(String[]).
      Parameters:
      newValue - is new value for the geoSystem field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGeoSystem

      public TransmitterPduObject setGeoSystem​(SFStringObject newValue)
      Assign single SFString object value to MFString geoSystem field, similar to setGeoSystem(String[]).
      Parameters:
      newValue - is new value for the geoSystem field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGeoSystem

      public TransmitterPduObject setGeoSystem​(java.lang.String newValue)
      Assign singleton String value to MFString geoSystem field, similar to setGeoSystem(String[]).
      Parameters:
      newValue - is new value for the geoSystem field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setGeoSystem

      public TransmitterPduObject setGeoSystem​(java.util.ArrayList<java.lang.String> newValue)
      Assign ArrayList value of MFString geoSystem field, similar to setGeoSystem(String[]).
      Parameters:
      newValue - is new value for the geoSystem field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • clearGeoSystem

      public TransmitterPduObject clearGeoSystem()
      Utility method to clear MFString value of geoSystem field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addGeoSystem

      public TransmitterPduObject addGeoSystem​(java.lang.String newValue)
      Add singleton String value to MFString geoSystem field.
      Parameters:
      newValue - is new value to add to the geoSystem field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • addGeoSystem

      public TransmitterPduObject addGeoSystem​(SFStringObject newValue)
      Add singleton SFStringObject value to MFString geoSystem field.
      Parameters:
      newValue - is new value to add to the geoSystem field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • getInputSource

      public 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). *
      Specified by:
      getInputSource in interface TransmitterPdu
      Returns:
      value of inputSource field
    • setInputSource

      public TransmitterPduObject 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). *
      Specified by:
      setInputSource in interface TransmitterPdu
      Parameters:
      newValue - is new value for the inputSource field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setInputSource

      public TransmitterPduObject setInputSource​(SFInt32Object newValue)
      Assign typed object value to SFInt32 inputSource field, similar to setInputSource(int).
      Parameters:
      newValue - is new value for the inputSource field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getIS

      public ISObject getIS()
      Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.
      Specified by:
      getIS in class X3DConcreteNode
      Returns:
      value of IS field
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • setIS

      public TransmitterPduObject setIS​(ISObject newValue)
      Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.
      Specified by:
      setIS in class X3DConcreteNode
      Parameters:
      newValue - is new value for the IS field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      X3D Tooltips: IS, X3D Tooltips: connect
    • clearIS

      public TransmitterPduObject clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • hasIS

      public boolean hasIS()
      Indicate whether an object is available for inputOutput SFNode field IS.
      Returns:
      whether a concrete statement or CommentsBlock is available.
      See Also:
      getIS()
    • getIsActive

      public 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 TransmitterPdu
      Specified by:
      getIsActive in interface X3DNetworkSensorNode
      Specified by:
      getIsActive in interface X3DSensorNode
      Returns:
      value of isActive field
    • getIsNetworkReader

      public 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.
      Specified by:
      getIsNetworkReader in interface TransmitterPdu
      Returns:
      value of isNetworkReader field
    • getIsNetworkWriter

      public 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.
      Specified by:
      getIsNetworkWriter in interface TransmitterPdu
      Returns:
      value of isNetworkWriter field
    • getIsRtpHeaderHeard

      public 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.
      Specified by:
      getIsRtpHeaderHeard in interface TransmitterPdu
      Returns:
      value of isRtpHeaderHeard field
    • getIsStandAlone

      public 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.
      Specified by:
      getIsStandAlone in interface TransmitterPdu
      Returns:
      value of isStandAlone field
    • getLengthOfModulationParameters

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

      Tooltip: . *
      Specified by:
      getLengthOfModulationParameters in interface TransmitterPdu
      Returns:
      value of lengthOfModulationParameters field
    • setLengthOfModulationParameters

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

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

      public TransmitterPduObject setLengthOfModulationParameters​(SFInt32Object newValue)
      Assign typed object value to SFInt32 lengthOfModulationParameters field, similar to setLengthOfModulationParameters(int).
      Parameters:
      newValue - is new value for the lengthOfModulationParameters field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface TransmitterPdu
      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:
      getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • setMetadata

      public TransmitterPduObject setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface TransmitterPdu
      Specified by:
      setMetadata in interface X3DChildNode
      Specified by:
      setMetadata in interface X3DNetworkSensorNode
      Specified by:
      setMetadata in interface X3DNode
      Specified by:
      setMetadata in interface X3DSensorNode
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(ProtoInstanceObject), X3D Scene Authoring Hints: Metadata Nodes
    • clearMetadata

      public TransmitterPduObject clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMetadata

      public TransmitterPduObject setMetadata​(ProtoInstanceObject newValue)
      Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in class X3DConcreteNode
      Parameters:
      newValue - is new value for the metadata field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      setMetadata(X3DMetadataObject)
    • hasMetadata

      public boolean hasMetadata()
      Indicate whether an object is available for inputOutput SFNode field metadata.
      Returns:
      whether a properly typed node or ProtoInstance or CommentsBlock is available.
      See Also:
      getMetadata(), getMetadataProtoInstance(), X3D Scene Authoring Hints: Metadata Nodes
    • getModulationTypeDetail

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

      Tooltip: Integer enumeration containing detailed information depending on the major modulation type. *
      Specified by:
      getModulationTypeDetail in interface TransmitterPdu
      Returns:
      value of modulationTypeDetail field
    • setModulationTypeDetail

      public TransmitterPduObject 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. *
      Specified by:
      setModulationTypeDetail in interface TransmitterPdu
      Parameters:
      newValue - is new value for the modulationTypeDetail field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setModulationTypeDetail

      public TransmitterPduObject setModulationTypeDetail​(SFInt32Object newValue)
      Assign typed object value to SFInt32 modulationTypeDetail field, similar to setModulationTypeDetail(int).
      Parameters:
      newValue - is new value for the modulationTypeDetail field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getModulationTypeMajor

      public 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). *
      Specified by:
      getModulationTypeMajor in interface TransmitterPdu
      Returns:
      value of modulationTypeMajor field
    • setModulationTypeMajor

      public TransmitterPduObject 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). *
      Specified by:
      setModulationTypeMajor in interface TransmitterPdu
      Parameters:
      newValue - is new value for the modulationTypeMajor field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setModulationTypeMajor

      public TransmitterPduObject setModulationTypeMajor​(SFInt32Object newValue)
      Assign typed object value to SFInt32 modulationTypeMajor field, similar to setModulationTypeMajor(int).
      Parameters:
      newValue - is new value for the modulationTypeMajor field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getModulationTypeSpreadSpectrum

      public 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. *
      Specified by:
      getModulationTypeSpreadSpectrum in interface TransmitterPdu
      Returns:
      value of modulationTypeSpreadSpectrum field
    • setModulationTypeSpreadSpectrum

      public TransmitterPduObject 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. *
      Specified by:
      setModulationTypeSpreadSpectrum in interface TransmitterPdu
      Parameters:
      newValue - is new value for the modulationTypeSpreadSpectrum field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setModulationTypeSpreadSpectrum

      public TransmitterPduObject setModulationTypeSpreadSpectrum​(SFInt32Object newValue)
      Assign typed object value to SFInt32 modulationTypeSpreadSpectrum field, similar to setModulationTypeSpreadSpectrum(int).
      Parameters:
      newValue - is new value for the modulationTypeSpreadSpectrum field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getModulationTypeSystem

      public 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. *
      Specified by:
      getModulationTypeSystem in interface TransmitterPdu
      Returns:
      value of modulationTypeSystem field
    • setModulationTypeSystem

      public TransmitterPduObject 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. *
      Specified by:
      setModulationTypeSystem in interface TransmitterPdu
      Parameters:
      newValue - is new value for the modulationTypeSystem field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setModulationTypeSystem

      public TransmitterPduObject setModulationTypeSystem​(SFInt32Object newValue)
      Assign typed object value to SFInt32 modulationTypeSystem field, similar to setModulationTypeSystem(int).
      Parameters:
      newValue - is new value for the modulationTypeSystem field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMulticastRelayHost

      public 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. *
      Specified by:
      getMulticastRelayHost in interface TransmitterPdu
      Returns:
      value of multicastRelayHost field
    • setMulticastRelayHost

      public TransmitterPduObject 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. *
      Specified by:
      setMulticastRelayHost in interface TransmitterPdu
      Parameters:
      newValue - is new value for the multicastRelayHost field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMulticastRelayHost

      public TransmitterPduObject setMulticastRelayHost​(SFStringObject newValue)
      Assign typed object value to SFString multicastRelayHost field, similar to setMulticastRelayHost(String).
      Parameters:
      newValue - is new value for the multicastRelayHost field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getMulticastRelayPort

      public int getMulticastRelayPort()
      Provide int value from inputOutput SFInt32 field named multicastRelayPort.

      Tooltip: Fallback server port if multicast not available locally. For example: 8010. *
      Specified by:
      getMulticastRelayPort in interface TransmitterPdu
      Returns:
      value of multicastRelayPort field
    • setMulticastRelayPort

      public TransmitterPduObject 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. *
      Specified by:
      setMulticastRelayPort in interface TransmitterPdu
      Parameters:
      newValue - is new value for the multicastRelayPort field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setMulticastRelayPort

      public TransmitterPduObject setMulticastRelayPort​(SFInt32Object newValue)
      Assign typed object value to SFInt32 multicastRelayPort field, similar to setMulticastRelayPort(int).
      Parameters:
      newValue - is new value for the multicastRelayPort field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getNetworkMode

      public 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.


      Available enumeration values for string comparison: STANDALONE, NETWORKREADER, NETWORKWRITER.
      Specified by:
      getNetworkMode in interface TransmitterPdu
      Returns:
      value of networkMode field
    • setNetworkMode

      public TransmitterPduObject setNetworkMode​(java.lang.String newValue)
      Accessor method to assign String enumeration value ("standAlone" | "networkReader" | "networkWriter") to inputOutput SFString field named networkMode.

      Warning: authors can only choose from a strict list of enumeration values (STANDALONE, NETWORKREADER, NETWORKWRITER).

      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.
      Specified by:
      setNetworkMode in interface TransmitterPdu
      Parameters:
      newValue - is new value for the networkMode field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setNetworkMode

      public TransmitterPduObject setNetworkMode​(SFStringObject newValue)
      Assign typed object value to SFString networkMode field, similar to setNetworkMode(String).
      Parameters:
      newValue - is new value for the networkMode field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getPort

      public int getPort()
      Provide int value from inputOutput SFInt32 field named port.

      Tooltip: Multicast network port, for example: 3000. *
      Specified by:
      getPort in interface TransmitterPdu
      Returns:
      value of port field
    • setPort

      public TransmitterPduObject setPort​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named port.

      Tooltip: Multicast network port, for example: 3000. *
      Specified by:
      setPort in interface TransmitterPdu
      Parameters:
      newValue - is new value for the port field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPort

      public TransmitterPduObject setPort​(SFInt32Object newValue)
      Assign typed object value to SFInt32 port field, similar to setPort(int).
      Parameters:
      newValue - is new value for the port field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getPower

      public 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. *
      Specified by:
      getPower in interface TransmitterPdu
      Returns:
      value of power field
    • setPower

      public TransmitterPduObject 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. *
      Specified by:
      setPower in interface TransmitterPdu
      Parameters:
      newValue - is new value for the power field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPower

      public TransmitterPduObject setPower​(SFFloatObject newValue)
      Assign typed object value to SFFloat power field, similar to setPower(float).
      Parameters:
      newValue - is new value for the power field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPower

      public TransmitterPduObject setPower​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setPower(float).
      Parameters:
      newValue - is new value for field
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getRadioEntityTypeCategory

      public 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. *
      Specified by:
      getRadioEntityTypeCategory in interface TransmitterPdu
      Returns:
      value of radioEntityTypeCategory field
    • setRadioEntityTypeCategory

      public TransmitterPduObject 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. *
      Specified by:
      setRadioEntityTypeCategory in interface TransmitterPdu
      Parameters:
      newValue - is new value for the radioEntityTypeCategory field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRadioEntityTypeCategory

      public TransmitterPduObject setRadioEntityTypeCategory​(SFInt32Object newValue)
      Assign typed object value to SFInt32 radioEntityTypeCategory field, similar to setRadioEntityTypeCategory(int).
      Parameters:
      newValue - is new value for the radioEntityTypeCategory field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getRadioEntityTypeCountry

      public 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. *
      Specified by:
      getRadioEntityTypeCountry in interface TransmitterPdu
      Returns:
      value of radioEntityTypeCountry field
    • setRadioEntityTypeCountry

      public TransmitterPduObject 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. *
      Specified by:
      setRadioEntityTypeCountry in interface TransmitterPdu
      Parameters:
      newValue - is new value for the radioEntityTypeCountry field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRadioEntityTypeCountry

      public TransmitterPduObject setRadioEntityTypeCountry​(SFInt32Object newValue)
      Assign typed object value to SFInt32 radioEntityTypeCountry field, similar to setRadioEntityTypeCountry(int).
      Parameters:
      newValue - is new value for the radioEntityTypeCountry field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getRadioEntityTypeDomain

      public 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. *
      Specified by:
      getRadioEntityTypeDomain in interface TransmitterPdu
      Returns:
      value of radioEntityTypeDomain field
    • setRadioEntityTypeDomain

      public TransmitterPduObject 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. *
      Specified by:
      setRadioEntityTypeDomain in interface TransmitterPdu
      Parameters:
      newValue - is new value for the radioEntityTypeDomain field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRadioEntityTypeDomain

      public TransmitterPduObject setRadioEntityTypeDomain​(SFInt32Object newValue)
      Assign typed object value to SFInt32 radioEntityTypeDomain field, similar to setRadioEntityTypeDomain(int).
      Parameters:
      newValue - is new value for the radioEntityTypeDomain field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getRadioEntityTypeKind

      public 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. *
      Specified by:
      getRadioEntityTypeKind in interface TransmitterPdu
      Returns:
      value of radioEntityTypeKind field
    • setRadioEntityTypeKind

      public TransmitterPduObject 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. *
      Specified by:
      setRadioEntityTypeKind in interface TransmitterPdu
      Parameters:
      newValue - is new value for the radioEntityTypeKind field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRadioEntityTypeKind

      public TransmitterPduObject setRadioEntityTypeKind​(SFInt32Object newValue)
      Assign typed object value to SFInt32 radioEntityTypeKind field, similar to setRadioEntityTypeKind(int).
      Parameters:
      newValue - is new value for the radioEntityTypeKind field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getRadioEntityTypeNomenclature

      public 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. *
      Specified by:
      getRadioEntityTypeNomenclature in interface TransmitterPdu
      Returns:
      value of radioEntityTypeNomenclature field
    • setRadioEntityTypeNomenclature

      public TransmitterPduObject 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. *
      Specified by:
      setRadioEntityTypeNomenclature in interface TransmitterPdu
      Parameters:
      newValue - is new value for the radioEntityTypeNomenclature field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRadioEntityTypeNomenclature

      public TransmitterPduObject setRadioEntityTypeNomenclature​(SFInt32Object newValue)
      Assign typed object value to SFInt32 radioEntityTypeNomenclature field, similar to setRadioEntityTypeNomenclature(int).
      Parameters:
      newValue - is new value for the radioEntityTypeNomenclature field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getRadioEntityTypeNomenclatureVersion

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

      Tooltip: Named equipment version number. *
      Specified by:
      getRadioEntityTypeNomenclatureVersion in interface TransmitterPdu
      Returns:
      value of radioEntityTypeNomenclatureVersion field
    • setRadioEntityTypeNomenclatureVersion

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

      Tooltip: Named equipment version number. *
      Specified by:
      setRadioEntityTypeNomenclatureVersion in interface TransmitterPdu
      Parameters:
      newValue - is new value for the radioEntityTypeNomenclatureVersion field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRadioEntityTypeNomenclatureVersion

      public TransmitterPduObject setRadioEntityTypeNomenclatureVersion​(SFInt32Object newValue)
      Assign typed object value to SFInt32 radioEntityTypeNomenclatureVersion field, similar to setRadioEntityTypeNomenclatureVersion(int).
      Parameters:
      newValue - is new value for the radioEntityTypeNomenclatureVersion field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getRadioID

      public int getRadioID()
      Provide int value from inputOutput SFInt32 field named radioID.

      Tooltip: Identifies a particular radio within a given entity. *
      Specified by:
      getRadioID in interface TransmitterPdu
      Returns:
      value of radioID field
    • setRadioID

      public TransmitterPduObject setRadioID​(int newValue)
      Accessor method to assign int value to inputOutput SFInt32 field named radioID.

      Tooltip: Identifies a particular radio within a given entity. *
      Specified by:
      setRadioID in interface TransmitterPdu
      Parameters:
      newValue - is new value for the radioID field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRadioID

      public TransmitterPduObject setRadioID​(SFInt32Object newValue)
      Assign typed object value to SFInt32 radioID field, similar to setRadioID(int).
      Parameters:
      newValue - is new value for the radioID field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getReadInterval

      public 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.
      Specified by:
      getReadInterval in interface TransmitterPdu
      Returns:
      value of readInterval field
    • setReadInterval

      public TransmitterPduObject 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.
      Specified by:
      setReadInterval in interface TransmitterPdu
      Parameters:
      newValue - is new value for the readInterval field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setReadInterval

      public TransmitterPduObject setReadInterval​(SFTimeObject newValue)
      Assign typed object value to SFTime readInterval field, similar to setReadInterval(double).
      Parameters:
      newValue - is new value for the readInterval field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getRelativeAntennaLocation

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

      Tooltip: Relative coordinates for antenna location. *
      Specified by:
      getRelativeAntennaLocation in interface TransmitterPdu
      Returns:
      value of relativeAntennaLocation field
    • setRelativeAntennaLocation

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

      Tooltip: Relative coordinates for antenna location. *
      Specified by:
      setRelativeAntennaLocation in interface TransmitterPdu
      Parameters:
      newValue - is new value for the relativeAntennaLocation field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRelativeAntennaLocation

      public TransmitterPduObject setRelativeAntennaLocation​(SFVec3fObject newValue)
      Assign typed object value to SFVec3f relativeAntennaLocation field, similar to setRelativeAntennaLocation(float[]).
      Parameters:
      newValue - is new value for the relativeAntennaLocation field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRelativeAntennaLocation

      public TransmitterPduObject setRelativeAntennaLocation​(float x, float y, float z)
      Assign values to SFVec3f relativeAntennaLocation field, similar to setRelativeAntennaLocation(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRelativeAntennaLocation

      public TransmitterPduObject setRelativeAntennaLocation​(double x, double y, double z)
      Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setRelativeAntennaLocation(float[]).
      Parameters:
      x - first component
      y - second component
      z - third component
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRelativeAntennaLocation

      public TransmitterPduObject setRelativeAntennaLocation​(double[] newArray)
      Utility method: double-precision set-array accessor for X3D floating-point type, similar to setRelativeAntennaLocation(float[]).
      Parameters:
      newArray - is new value for field
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getRtpHeaderExpected

      public boolean getRtpHeaderExpected()
      Provide boolean value from initializeOnly SFBool field named rtpHeaderExpected.

      Tooltip: Whether RTP headers are prepended to DIS PDUs. *
      Specified by:
      getRtpHeaderExpected in interface TransmitterPdu
      Returns:
      value of rtpHeaderExpected field
    • setRtpHeaderExpected

      public TransmitterPduObject setRtpHeaderExpected​(boolean newValue)
      Accessor method to assign boolean value to initializeOnly SFBool field named rtpHeaderExpected.

      Tooltip: Whether RTP headers are prepended to DIS PDUs. *
      Specified by:
      setRtpHeaderExpected in interface TransmitterPdu
      Parameters:
      newValue - is new value for the rtpHeaderExpected field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRtpHeaderExpected

      public TransmitterPduObject setRtpHeaderExpected​(SFBoolObject newValue)
      Assign typed object value to SFBool rtpHeaderExpected field, similar to setRtpHeaderExpected(boolean).
      Parameters:
      newValue - is new value for the rtpHeaderExpected field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getSiteID

      public int getSiteID()
      Provide int value from inputOutput SFInt32 field named siteID.

      Tooltip: Simulation/exercise siteID of the participating LAN or organization. *
      Specified by:
      getSiteID in interface TransmitterPdu
      Returns:
      value of siteID field
    • setSiteID

      public TransmitterPduObject 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. *
      Specified by:
      setSiteID in interface TransmitterPdu
      Parameters:
      newValue - is new value for the siteID field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setSiteID

      public TransmitterPduObject setSiteID​(SFInt32Object newValue)
      Assign typed object value to SFInt32 siteID field, similar to setSiteID(int).
      Parameters:
      newValue - is new value for the siteID field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getTimestamp

      public 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.
      Specified by:
      getTimestamp in interface TransmitterPdu
      Returns:
      value of timestamp field
    • getTransmitFrequencyBandwidth

      public 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). *
      Specified by:
      getTransmitFrequencyBandwidth in interface TransmitterPdu
      Returns:
      value of transmitFrequencyBandwidth field
    • setTransmitFrequencyBandwidth

      public TransmitterPduObject 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). *
      Specified by:
      setTransmitFrequencyBandwidth in interface TransmitterPdu
      Parameters:
      newValue - is new value for the transmitFrequencyBandwidth field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTransmitFrequencyBandwidth

      public TransmitterPduObject setTransmitFrequencyBandwidth​(SFFloatObject newValue)
      Assign typed object value to SFFloat transmitFrequencyBandwidth field, similar to setTransmitFrequencyBandwidth(float).
      Parameters:
      newValue - is new value for the transmitFrequencyBandwidth field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTransmitFrequencyBandwidth

      public TransmitterPduObject setTransmitFrequencyBandwidth​(double newValue)
      Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setTransmitFrequencyBandwidth(float).
      Parameters:
      newValue - is new value for field
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getTransmitState

      public 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,. *
      Specified by:
      getTransmitState in interface TransmitterPdu
      Returns:
      value of transmitState field
    • setTransmitState

      public TransmitterPduObject 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,. *
      Specified by:
      setTransmitState in interface TransmitterPdu
      Parameters:
      newValue - is new value for the transmitState field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTransmitState

      public TransmitterPduObject setTransmitState​(SFInt32Object newValue)
      Assign typed object value to SFInt32 transmitState field, similar to setTransmitState(int).
      Parameters:
      newValue - is new value for the transmitState field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getWhichGeometry

      public 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. *
      Specified by:
      getWhichGeometry in interface TransmitterPdu
      Returns:
      value of whichGeometry field
    • setWhichGeometry

      public TransmitterPduObject 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. *
      Specified by:
      setWhichGeometry in interface TransmitterPdu
      Parameters:
      newValue - is new value for the whichGeometry field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setWhichGeometry

      public TransmitterPduObject setWhichGeometry​(SFInt32Object newValue)
      Assign typed object value to SFInt32 whichGeometry field, similar to setWhichGeometry(int).
      Parameters:
      newValue - is new value for the whichGeometry field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getWriteInterval

      public 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.
      Specified by:
      getWriteInterval in interface TransmitterPdu
      Returns:
      value of writeInterval field
    • setWriteInterval

      public TransmitterPduObject 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.
      Specified by:
      setWriteInterval in interface TransmitterPdu
      Parameters:
      newValue - is new value for the writeInterval field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setWriteInterval

      public TransmitterPduObject setWriteInterval​(SFTimeObject newValue)
      Assign typed object value to SFTime writeInterval field, similar to setWriteInterval(double).
      Parameters:
      newValue - is new value for the writeInterval field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getDEF

      public java.lang.String getDEF()
      Provide String value from inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.
      Overrides:
      getDEF in class X3DConcreteNode
      Returns:
      value of DEF field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setDEF

      public final TransmitterPduObject setDEF​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named DEF.

      Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.

      Note that setting the DEF value clears the USE value.
      Specified by:
      setDEF in class X3DConcreteNode
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setDEF

      public TransmitterPduObject setDEF​(SFStringObject newValue)
      Assign typed object value to SFString DEF field, similar to setDEF(String).
      Parameters:
      newValue - is new value for the DEF field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getUSE

      public java.lang.String getUSE()
      Provide String value from inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
      Overrides:
      getUSE in class X3DConcreteNode
      Returns:
      value of USE field
      See Also:
      X3D Scene Authoring Hints: Naming Conventions
    • setUSE

      public final TransmitterPduObject setUSE​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named USE.

      Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).
      • Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
      • Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
      • Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.


      Note: each USE node is still an independent object, with the USE value matching the DEF value in the preceding object.

      Warning: invoking the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Specified by:
      setUSE in class X3DConcreteNode
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public TransmitterPduObject setUSE​(SFStringObject newValue)
      Assign typed object value to SFString USE field, similar to setUSE(String).
      Parameters:
      newValue - is new value for the USE field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • getCssClass

      public java.lang.String getCssClass()
      Provide String value from inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Overrides:
      getCssClass in class X3DConcreteNode
      Returns:
      value of class field
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public final TransmitterPduObject setCssClass​(java.lang.String newValue)
      Accessor method to assign String value to inputOutput SFString field named class.

      Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.
      • Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
      • Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
      Specified by:
      setCssClass in class X3DConcreteNode
      Parameters:
      newValue - is new value for the class field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      W3C Cascading Style Sheets
    • setCssClass

      public TransmitterPduObject setCssClass​(SFStringObject newValue)
      Assign typed object value to SFString cssClass field, similar to setCssClass(String).
      Parameters:
      newValue - is new value for the class field.
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setUSE

      public TransmitterPduObject setUSE​(TransmitterPduObject DEFnode)
      Assign a USE reference to another DEF node of same node type, similar to setUSE(String).

      Warning: note that the setUSE() method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.

      Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.
      Parameters:
      DEFnode - must have a DEF value defined
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • addComments

      public TransmitterPduObject addComments​(java.lang.String newComment)
      Add comment as String to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComment - initial value
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public TransmitterPduObject addComments​(java.lang.String[] newComments)
      Add comments as String[] array to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newComments - array of comments
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public TransmitterPduObject addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      TransmitterPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • toStringX3D

      public java.lang.String toStringX3D​(int indentLevel)
      Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
      Specified by:
      toStringX3D in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      X3D string
      See Also:
      X3DObject.FILE_EXTENSION_X3D, X3DObject.FILE_EXTENSION_XML, X3DObject.toStringXML(), X3DObject.toFileXML(String), X3DObject.toFileX3D(String), X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
    • toStringClassicVRML

      public java.lang.String toStringClassicVRML​(int indentLevel)
      Recursive method to provide ClassicVRML string serialization.
      Specified by:
      toStringClassicVRML in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      ClassicVRML string
      See Also:
      X3DObject.FILE_EXTENSION_CLASSICVRML, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
    • toStringVRML97

      public java.lang.String toStringVRML97​(int indentLevel)
      Recursive method to provide VRML97 string serialization.
      Specified by:
      toStringVRML97 in class X3DConcreteElement
      Parameters:
      indentLevel - number of levels of indentation for this element
      Returns:
      VRML97 string
      See Also:
      X3DObject.FILE_EXTENSION_VRML97, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • findElementByNameValue

      public X3DConcreteElement findElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.

      Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

      Warning: more than one element may be found that has the same name, this method does not handle that case.
      Specified by:
      findElementByNameValue in class X3DConcreteElement
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      object reference to found element, null otherwise
      See Also:
      findNodeByDEF(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • hasElementByNameValue

      public boolean hasElementByNameValue​(java.lang.String nameValue, java.lang.String elementName)
      Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.
      Parameters:
      nameValue - is value of the name field being searched for in this element and child elements(if any)
      elementName - identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)
      Returns:
      whether node is found
      See Also:
      findElementByNameValue(String, String)
    • findNodeByDEF

      public X3DConcreteNode findNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.

      Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.

      Warning: more than one element may be found that has the same DEF, this method does not handle that case.
      Specified by:
      findNodeByDEF in class X3DConcreteElement
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      object reference to found node, null otherwise
      See Also:
      findElementByNameValue(String), X3DConcreteElement.hasAncestorSceneObject(), X3DConcreteElement.findAncestorX3DObject()
    • hasNodeByDEF

      public boolean hasNodeByDEF​(java.lang.String DEFvalue)
      Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
      Parameters:
      DEFvalue - is value of the name field being searched for in this element and child elements(if any)
      Returns:
      whether node is found
      See Also:
      findNodeByDEF(String)
    • validate

      public java.lang.String validate()
      Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.
      Specified by:
      validate in class X3DConcreteElement
      Returns:
      validation results (if any)