Class ReceiverPduObject

    • Field Detail

      • NETWORKMODE_STANDALONE

        public static final java.lang.String NETWORKMODE_STANDALONE
        SFString field named networkMode with X3DUOM baseType networkModeChoices can equal this value "standAlone" (Java syntax) or standAlone (XML syntax).
        See Also:
        networkModeChoices, Constant Field Values
      • NETWORKMODE_NETWORKREADER

        public static final java.lang.String NETWORKMODE_NETWORKREADER
        SFString field named networkMode with X3DUOM baseType networkModeChoices can equal this value "networkReader" (Java syntax) or networkReader (XML syntax).
        See Also:
        networkModeChoices, Constant Field Values
      • NETWORKMODE_NETWORKWRITER

        public static final java.lang.String NETWORKMODE_NETWORKWRITER
        SFString field named networkMode with X3DUOM baseType networkModeChoices can equal this value "networkWriter" (Java syntax) or networkWriter (XML syntax).
        See Also:
        networkModeChoices, Constant Field Values
      • NAME

        public static final java.lang.String NAME
        String constant NAME provides name of this element: ReceiverPdu.
        See Also:
        Constant Field Values
      • COMPONENT

        public static final java.lang.String COMPONENT
        String constant COMPONENT defines X3D component for the ReceiverPdu element: DIS
        See Also:
        Constant Field Values
      • LEVEL

        public static final int LEVEL
        Integer constant LEVEL provides default X3D DIS component level for this element: 1
        See Also:
        Constant Field Values
      • ADDRESS_DEFAULT_VALUE

        public static final java.lang.String ADDRESS_DEFAULT_VALUE
        SFString field named address has default value "localhost" (Java syntax) or localhost (XML syntax).
        See Also:
        Constant Field Values
      • APPLICATIONID_DEFAULT_VALUE

        public static final int APPLICATIONID_DEFAULT_VALUE
        SFInt32 field named applicationID has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • BBOXCENTER_DEFAULT_VALUE

        public static final float[] BBOXCENTER_DEFAULT_VALUE
        SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
      • BBOXSIZE_DEFAULT_VALUE

        public static final float[] BBOXSIZE_DEFAULT_VALUE
        SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
      • ENABLED_DEFAULT_VALUE

        public static final boolean ENABLED_DEFAULT_VALUE
        SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
        See Also:
        Constant Field Values
      • ENTITYID_DEFAULT_VALUE

        public static final int ENTITYID_DEFAULT_VALUE
        SFInt32 field named entityID has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • GEOCOORDS_DEFAULT_VALUE

        public static final double[] GEOCOORDS_DEFAULT_VALUE
        SFVec3d field named geoCoords has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax).
      • GEOSYSTEM_DEFAULT_VALUE

        public static final java.util.ArrayList<java.lang.String> GEOSYSTEM_DEFAULT_VALUE
        MFString field named geoSystem has default quoted value new String[] {"GD","WE"} (Java syntax) or quoted value "GD" "WE" (XML syntax).
      • IS_DEFAULT_VALUE

        public static final ISObject IS_DEFAULT_VALUE
        SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
      • METADATA_DEFAULT_VALUE

        public static final X3DMetadataObject METADATA_DEFAULT_VALUE
        SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
      • MULTICASTRELAYHOST_DEFAULT_VALUE

        public static final java.lang.String MULTICASTRELAYHOST_DEFAULT_VALUE
        SFString field named multicastRelayHost has default value equal to an empty string.
        See Also:
        Constant Field Values
      • MULTICASTRELAYPORT_DEFAULT_VALUE

        public static final int MULTICASTRELAYPORT_DEFAULT_VALUE
        SFInt32 field named multicastRelayPort has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • NETWORKMODE_DEFAULT_VALUE

        public static final java.lang.String NETWORKMODE_DEFAULT_VALUE
        SFString field named networkMode has default value "standAlone" (Java syntax) or standAlone (XML syntax).
        See Also:
        Constant Field Values
      • PORT_DEFAULT_VALUE

        public static final int PORT_DEFAULT_VALUE
        SFInt32 field named port has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • RADIOID_DEFAULT_VALUE

        public static final int RADIOID_DEFAULT_VALUE
        SFInt32 field named radioID has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • READINTERVAL_DEFAULT_VALUE

        public static final double READINTERVAL_DEFAULT_VALUE
        SFTime field named readInterval has default value 0.1 (Java syntax) or 0.1 (XML syntax).
        See Also:
        Constant Field Values
      • RECEIVEDPOWER_DEFAULT_VALUE

        public static final float RECEIVEDPOWER_DEFAULT_VALUE
        SFFloat field named receivedPower has default value 0.0f (Java syntax) or 0.0 (XML syntax).
        See Also:
        Constant Field Values
      • RECEIVERSTATE_DEFAULT_VALUE

        public static final int RECEIVERSTATE_DEFAULT_VALUE
        SFInt32 field named receiverState has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • RTPHEADEREXPECTED_DEFAULT_VALUE

        public static final boolean RTPHEADEREXPECTED_DEFAULT_VALUE
        SFBool field named rtpHeaderExpected has default value false (Java syntax) or false (XML syntax).
        See Also:
        Constant Field Values
      • SITEID_DEFAULT_VALUE

        public static final int SITEID_DEFAULT_VALUE
        SFInt32 field named siteID has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • TRANSMITTERAPPLICATIONID_DEFAULT_VALUE

        public static final int TRANSMITTERAPPLICATIONID_DEFAULT_VALUE
        SFInt32 field named transmitterApplicationID has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • TRANSMITTERENTITYID_DEFAULT_VALUE

        public static final int TRANSMITTERENTITYID_DEFAULT_VALUE
        SFInt32 field named transmitterEntityID has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • TRANSMITTERRADIOID_DEFAULT_VALUE

        public static final int TRANSMITTERRADIOID_DEFAULT_VALUE
        SFInt32 field named transmitterRadioID has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • TRANSMITTERSITEID_DEFAULT_VALUE

        public static final int TRANSMITTERSITEID_DEFAULT_VALUE
        SFInt32 field named transmitterSiteID has default value 0 (Java syntax) or 0 (XML syntax).
        See Also:
        Constant Field Values
      • WHICHGEOMETRY_DEFAULT_VALUE

        public static final int WHICHGEOMETRY_DEFAULT_VALUE
        SFInt32 field named whichGeometry has default value 1 (Java syntax) or 1 (XML syntax).
        See Also:
        Constant Field Values
      • WRITEINTERVAL_DEFAULT_VALUE

        public static final double WRITEINTERVAL_DEFAULT_VALUE
        SFTime field named writeInterval has default value 1.0 (Java syntax) or 1.0 (XML syntax).
        See Also:
        Constant Field Values
      • fromField_ADDRESS

        public static final java.lang.String fromField_ADDRESS
        fromField ROUTE name for SFString field named address.
        See Also:
        Constant Field Values
      • toField_ADDRESS

        public static final java.lang.String toField_ADDRESS
        toField ROUTE name for SFString field named address.
        See Also:
        Constant Field Values
      • fromField_APPLICATIONID

        public static final java.lang.String fromField_APPLICATIONID
        fromField ROUTE name for SFInt32 field named applicationID.
        See Also:
        Constant Field Values
      • toField_APPLICATIONID

        public static final java.lang.String toField_APPLICATIONID
        toField ROUTE name for SFInt32 field named applicationID.
        See Also:
        Constant Field Values
      • fromField_ENABLED

        public static final java.lang.String fromField_ENABLED
        fromField ROUTE name for SFBool field named enabled.
        See Also:
        Constant Field Values
      • toField_ENABLED

        public static final java.lang.String toField_ENABLED
        toField ROUTE name for SFBool field named enabled.
        See Also:
        Constant Field Values
      • fromField_ENTITYID

        public static final java.lang.String fromField_ENTITYID
        fromField ROUTE name for SFInt32 field named entityID.
        See Also:
        Constant Field Values
      • toField_ENTITYID

        public static final java.lang.String toField_ENTITYID
        toField ROUTE name for SFInt32 field named entityID.
        See Also:
        Constant Field Values
      • fromField_GEOCOORDS

        public static final java.lang.String fromField_GEOCOORDS
        fromField ROUTE name for SFVec3d field named geoCoords.
        See Also:
        Constant Field Values
      • toField_GEOCOORDS

        public static final java.lang.String toField_GEOCOORDS
        toField ROUTE name for SFVec3d field named geoCoords.
        See Also:
        Constant Field Values
      • fromField_IS

        public static final java.lang.String fromField_IS
        fromField ROUTE name for SFNode field named IS.
        See Also:
        Constant Field Values
      • fromField_ISACTIVE

        public static final java.lang.String fromField_ISACTIVE
        fromField ROUTE name for SFBool field named isActive.
        See Also:
        Constant Field Values
      • fromField_ISNETWORKREADER

        public static final java.lang.String fromField_ISNETWORKREADER
        fromField ROUTE name for SFBool field named isNetworkReader.
        See Also:
        Constant Field Values
      • fromField_ISNETWORKWRITER

        public static final java.lang.String fromField_ISNETWORKWRITER
        fromField ROUTE name for SFBool field named isNetworkWriter.
        See Also:
        Constant Field Values
      • fromField_ISRTPHEADERHEARD

        public static final java.lang.String fromField_ISRTPHEADERHEARD
        fromField ROUTE name for SFBool field named isRtpHeaderHeard.
        See Also:
        Constant Field Values
      • fromField_ISSTANDALONE

        public static final java.lang.String fromField_ISSTANDALONE
        fromField ROUTE name for SFBool field named isStandAlone.
        See Also:
        Constant Field Values
      • fromField_METADATA

        public static final java.lang.String fromField_METADATA
        fromField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • toField_METADATA

        public static final java.lang.String toField_METADATA
        toField ROUTE name for SFNode field named metadata.
        See Also:
        Constant Field Values
      • fromField_MULTICASTRELAYHOST

        public static final java.lang.String fromField_MULTICASTRELAYHOST
        fromField ROUTE name for SFString field named multicastRelayHost.
        See Also:
        Constant Field Values
      • toField_MULTICASTRELAYHOST

        public static final java.lang.String toField_MULTICASTRELAYHOST
        toField ROUTE name for SFString field named multicastRelayHost.
        See Also:
        Constant Field Values
      • fromField_MULTICASTRELAYPORT

        public static final java.lang.String fromField_MULTICASTRELAYPORT
        fromField ROUTE name for SFInt32 field named multicastRelayPort.
        See Also:
        Constant Field Values
      • toField_MULTICASTRELAYPORT

        public static final java.lang.String toField_MULTICASTRELAYPORT
        toField ROUTE name for SFInt32 field named multicastRelayPort.
        See Also:
        Constant Field Values
      • fromField_NETWORKMODE

        public static final java.lang.String fromField_NETWORKMODE
        fromField ROUTE name for SFString field named networkMode.
        See Also:
        Constant Field Values
      • toField_NETWORKMODE

        public static final java.lang.String toField_NETWORKMODE
        toField ROUTE name for SFString field named networkMode.
        See Also:
        Constant Field Values
      • fromField_PORT

        public static final java.lang.String fromField_PORT
        fromField ROUTE name for SFInt32 field named port.
        See Also:
        Constant Field Values
      • toField_PORT

        public static final java.lang.String toField_PORT
        toField ROUTE name for SFInt32 field named port.
        See Also:
        Constant Field Values
      • fromField_RADIOID

        public static final java.lang.String fromField_RADIOID
        fromField ROUTE name for SFInt32 field named radioID.
        See Also:
        Constant Field Values
      • toField_RADIOID

        public static final java.lang.String toField_RADIOID
        toField ROUTE name for SFInt32 field named radioID.
        See Also:
        Constant Field Values
      • fromField_READINTERVAL

        public static final java.lang.String fromField_READINTERVAL
        fromField ROUTE name for SFTime field named readInterval.
        See Also:
        Constant Field Values
      • toField_READINTERVAL

        public static final java.lang.String toField_READINTERVAL
        toField ROUTE name for SFTime field named readInterval.
        See Also:
        Constant Field Values
      • fromField_RECEIVEDPOWER

        public static final java.lang.String fromField_RECEIVEDPOWER
        fromField ROUTE name for SFFloat field named receivedPower.
        See Also:
        Constant Field Values
      • toField_RECEIVEDPOWER

        public static final java.lang.String toField_RECEIVEDPOWER
        toField ROUTE name for SFFloat field named receivedPower.
        See Also:
        Constant Field Values
      • fromField_RECEIVERSTATE

        public static final java.lang.String fromField_RECEIVERSTATE
        fromField ROUTE name for SFInt32 field named receiverState.
        See Also:
        Constant Field Values
      • toField_RECEIVERSTATE

        public static final java.lang.String toField_RECEIVERSTATE
        toField ROUTE name for SFInt32 field named receiverState.
        See Also:
        Constant Field Values
      • fromField_SITEID

        public static final java.lang.String fromField_SITEID
        fromField ROUTE name for SFInt32 field named siteID.
        See Also:
        Constant Field Values
      • toField_SITEID

        public static final java.lang.String toField_SITEID
        toField ROUTE name for SFInt32 field named siteID.
        See Also:
        Constant Field Values
      • fromField_TIMESTAMP

        public static final java.lang.String fromField_TIMESTAMP
        fromField ROUTE name for SFTime field named timestamp.
        See Also:
        Constant Field Values
      • fromField_TRANSMITTERAPPLICATIONID

        public static final java.lang.String fromField_TRANSMITTERAPPLICATIONID
        fromField ROUTE name for SFInt32 field named transmitterApplicationID.
        See Also:
        Constant Field Values
      • toField_TRANSMITTERAPPLICATIONID

        public static final java.lang.String toField_TRANSMITTERAPPLICATIONID
        toField ROUTE name for SFInt32 field named transmitterApplicationID.
        See Also:
        Constant Field Values
      • fromField_TRANSMITTERENTITYID

        public static final java.lang.String fromField_TRANSMITTERENTITYID
        fromField ROUTE name for SFInt32 field named transmitterEntityID.
        See Also:
        Constant Field Values
      • toField_TRANSMITTERENTITYID

        public static final java.lang.String toField_TRANSMITTERENTITYID
        toField ROUTE name for SFInt32 field named transmitterEntityID.
        See Also:
        Constant Field Values
      • fromField_TRANSMITTERRADIOID

        public static final java.lang.String fromField_TRANSMITTERRADIOID
        fromField ROUTE name for SFInt32 field named transmitterRadioID.
        See Also:
        Constant Field Values
      • toField_TRANSMITTERRADIOID

        public static final java.lang.String toField_TRANSMITTERRADIOID
        toField ROUTE name for SFInt32 field named transmitterRadioID.
        See Also:
        Constant Field Values
      • fromField_TRANSMITTERSITEID

        public static final java.lang.String fromField_TRANSMITTERSITEID
        fromField ROUTE name for SFInt32 field named transmitterSiteID.
        See Also:
        Constant Field Values
      • toField_TRANSMITTERSITEID

        public static final java.lang.String toField_TRANSMITTERSITEID
        toField ROUTE name for SFInt32 field named transmitterSiteID.
        See Also:
        Constant Field Values
      • fromField_WHICHGEOMETRY

        public static final java.lang.String fromField_WHICHGEOMETRY
        fromField ROUTE name for SFInt32 field named whichGeometry.
        See Also:
        Constant Field Values
      • toField_WHICHGEOMETRY

        public static final java.lang.String toField_WHICHGEOMETRY
        toField ROUTE name for SFInt32 field named whichGeometry.
        See Also:
        Constant Field Values
      • fromField_WRITEINTERVAL

        public static final java.lang.String fromField_WRITEINTERVAL
        fromField ROUTE name for SFTime field named writeInterval.
        See Also:
        Constant Field Values
      • toField_WRITEINTERVAL

        public static final java.lang.String toField_WRITEINTERVAL
        toField ROUTE name for SFTime field named writeInterval.
        See Also:
        Constant Field Values
    • Constructor Detail

      • 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 Detail

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