Class ReceiverPduObject

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

public class ReceiverPduObject
extends X3DConcreteNode
implements ReceiverPdu
ReceiverPdu is a networked Protocol Data Unit (PDU) information node that transmits the state of radio frequency (RF) receivers modeled in a simulation.

X3D node tooltip: [X3DNetworkSensorNode,X3DBoundedObject] ReceiverPdu is a networked Protocol Data Unit (PDU) information node that transmits the state of radio frequency (RF) receivers modeled in a simulation.
Package hint: This 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: ReceiverPdu, X3D Tooltips: ReceiverPdu, X3D Scene Authoring Hints
  • Field Details

  • Constructor Details

    • ReceiverPduObject

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

      public ReceiverPduObject​(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: ReceiverPdu
      Specified by:
      getElementName in class X3DConcreteElement
      Returns:
      name of this element
    • getComponent

      public final java.lang.String getComponent()
      Defines X3D component for the ReceiverPdu 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 ReceiverPdu
      Returns:
      value of address field
    • setAddress

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

      public ReceiverPduObject 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:
      ReceiverPduObject - 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 ReceiverPdu
      Returns:
      value of applicationID field
    • setApplicationID

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

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

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

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

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

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

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

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

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

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

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

      public ReceiverPduObject 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:
      ReceiverPduObject - 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 ReceiverPdu
      Specified by:
      getEnabled in interface X3DNetworkSensorNode
      Specified by:
      getEnabled in interface X3DSensorNode
      Returns:
      value of enabled field
    • setEnabled

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

      public ReceiverPduObject 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:
      ReceiverPduObject - 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 ReceiverPdu
      Returns:
      value of entityID field
    • setEntityID

      public ReceiverPduObject 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 ReceiverPdu
      Parameters:
      newValue - is new value for the entityID field.
      Returns:
      ReceiverPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setEntityID

      public ReceiverPduObject 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:
      ReceiverPduObject - 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 ReceiverPdu
      Returns:
      value of geoCoords field
    • setGeoCoords

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

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

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

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

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

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

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

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

      public ReceiverPduObject 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:
      ReceiverPduObject - 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 ReceiverPduObject addGeoSystem​(SFStringObject newValue)
      Add singleton SFStringObject value to MFString geoSystem field.
      Parameters:
      newValue - is new value to add to the geoSystem field.
      Returns:
      ReceiverPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
      See Also:
      MFStringObject.cleanupEnumerationValues(String)
    • 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 ReceiverPduObject 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:
      ReceiverPduObject - 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 ReceiverPduObject clearIS()
      Utility method to clear SFNode value of IS field.
      Returns:
      ReceiverPduObject - 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 ReceiverPdu
      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 ReceiverPdu
      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 ReceiverPdu
      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 ReceiverPdu
      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 ReceiverPdu
      Returns:
      value of isStandAlone field
    • getMetadata

      public X3DMetadataObject getMetadata()
      Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
      Specified by:
      getMetadata in interface ReceiverPdu
      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 ReceiverPduObject setMetadata​(X3DMetadataObject newValue)
      Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
      Specified by:
      setMetadata in interface ReceiverPdu
      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:
      ReceiverPduObject - 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 ReceiverPduObject clearMetadata()
      Utility method to clear SFNode value of metadata field.
      Returns:
      ReceiverPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • setMetadata

      public ReceiverPduObject 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:
      ReceiverPduObject - 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
    • 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 ReceiverPdu
      Returns:
      value of multicastRelayHost field
    • setMulticastRelayHost

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

      public ReceiverPduObject 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:
      ReceiverPduObject - 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 ReceiverPdu
      Returns:
      value of multicastRelayPort field
    • setMulticastRelayPort

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

      public ReceiverPduObject 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:
      ReceiverPduObject - 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 ReceiverPdu
      Returns:
      value of networkMode field
    • setNetworkMode

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

      public ReceiverPduObject 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:
      ReceiverPduObject - 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 ReceiverPdu
      Returns:
      value of port field
    • setPort

      public ReceiverPduObject 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 ReceiverPdu
      Parameters:
      newValue - is new value for the port field.
      Returns:
      ReceiverPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setPort

      public ReceiverPduObject 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:
      ReceiverPduObject - 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 ReceiverPdu
      Returns:
      value of radioID field
    • setRadioID

      public ReceiverPduObject 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 ReceiverPdu
      Parameters:
      newValue - is new value for the radioID field.
      Returns:
      ReceiverPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRadioID

      public ReceiverPduObject 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:
      ReceiverPduObject - 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 ReceiverPdu
      Returns:
      value of readInterval field
    • setReadInterval

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

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

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

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

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

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

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

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

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

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

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

      Tooltip: receiverState indicates if receiver is currently idle or busy via one of these enumerated values: 0 = off, 1 = on but not receiving, or 2 = on and receiving. *
      Specified by:
      setReceiverState in interface ReceiverPdu
      Parameters:
      newValue - is new value for the receiverState field.
      Returns:
      ReceiverPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setReceiverState

      public ReceiverPduObject setReceiverState​(SFInt32Object newValue)
      Assign typed object value to SFInt32 receiverState field, similar to setReceiverState(int).
      Parameters:
      newValue - is new value for the receiverState field.
      Returns:
      ReceiverPduObject - 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 ReceiverPdu
      Returns:
      value of rtpHeaderExpected field
    • setRtpHeaderExpected

      public ReceiverPduObject 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 ReceiverPdu
      Parameters:
      newValue - is new value for the rtpHeaderExpected field.
      Returns:
      ReceiverPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setRtpHeaderExpected

      public ReceiverPduObject 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:
      ReceiverPduObject - 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 ReceiverPdu
      Returns:
      value of siteID field
    • setSiteID

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

      public ReceiverPduObject 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:
      ReceiverPduObject - 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 ReceiverPdu
      Returns:
      value of timestamp field
    • getTransmitterApplicationID

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

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

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

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

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

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

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

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

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

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

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

      Tooltip: Identifies a particular radio within a given entity. *
      Specified by:
      getTransmitterRadioID in interface ReceiverPdu
      Returns:
      value of transmitterRadioID field
    • setTransmitterRadioID

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

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

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

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

      Tooltip: Simulation/exercise transmitterSiteID of the participating LAN or organization. *
      Specified by:
      getTransmitterSiteID in interface ReceiverPdu
      Returns:
      value of transmitterSiteID field
    • setTransmitterSiteID

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

      Tooltip: Simulation/exercise transmitterSiteID of the participating LAN or organization. *
      Specified by:
      setTransmitterSiteID in interface ReceiverPdu
      Parameters:
      newValue - is new value for the transmitterSiteID field.
      Returns:
      ReceiverPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
    • setTransmitterSiteID

      public ReceiverPduObject setTransmitterSiteID​(SFInt32Object newValue)
      Assign typed object value to SFInt32 transmitterSiteID field, similar to setTransmitterSiteID(int).
      Parameters:
      newValue - is new value for the transmitterSiteID field.
      Returns:
      ReceiverPduObject - 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 ReceiverPdu
      Returns:
      value of whichGeometry field
    • setWhichGeometry

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

      public ReceiverPduObject 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:
      ReceiverPduObject - 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 ReceiverPdu
      Returns:
      value of writeInterval field
    • setWriteInterval

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

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

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

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

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

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

      public ReceiverPduObject 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:
      ReceiverPduObject - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
    • addComments

      public ReceiverPduObject addComments​(CommentsBlock newCommentsBlock)
      Add CommentsBlock to contained commentsList.
      Specified by:
      addComments in class X3DConcreteElement
      Parameters:
      newCommentsBlock - block of comments to add
      Returns:
      ReceiverPduObject - 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)