Class ReceiverPdu

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.DIS.ReceiverPdu

All Implemented Interfaces:

X3DChildNode, X3DNode, X3DSensorNode, ReceiverPdu, X3DBoundedObject, X3DNetworkSensorNode

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

ReceiverPdu node tooltip: [X3DNetworkSensorNode,X3DBoundedObject,X3DVisibleObject] ReceiverPdu is a networked Protocol Data Unit (PDU) information node that transmits the state of radio frequency (RF) receivers modeled in a simulation.

• Hint: ReceiverPdu packets use the IEEE Distributed Interactive Simulation (DIS) protocol.
• Hint: Savage Developers Guide on DIS https://savage.nps.edu/Savage/developers.html#DIS
• Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/DistributedInteractiveSimulation.pdf
• Warning: requires X3D profile='Full' or else include <component name='DIS' level='1'/>

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 Summary

Fields

Modifier and Type	Field	Description
static final String	ADDRESS_DEFAULT_VALUE	SFString field named address has default value "localhost" (Java syntax) or localhost (XML syntax).
static final int	APPLICATIONID_DEFAULT_VALUE	SFInt32 field named applicationID has default value 0 (Java syntax) or 0 (XML syntax).
static final float[]	BBOXCENTER_DEFAULT_VALUE	SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).
static final boolean	BBOXDISPLAY_DEFAULT_VALUE	SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).
static final float[]	BBOXSIZE_DEFAULT_VALUE	SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).
static final String	COMPONENT	String constant COMPONENT defines X3D component for the ReceiverPdu element: DIS
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final String	DESCRIPTION_DEFAULT_VALUE	SFString field named description has default value equal to an empty string.
static final boolean	ENABLED_DEFAULT_VALUE	SFBool field named enabled has default value true (Java syntax) or true (XML syntax).
static final int	ENTITYID_DEFAULT_VALUE	SFInt32 field named entityID has default value 0 (Java syntax) or 0 (XML syntax).
static final String	fromField_ADDRESS	fromField ROUTE name for SFString field named address.
static final String	fromField_APPLICATIONID	fromField ROUTE name for SFInt32 field named applicationID.
static final String	fromField_BBOXDISPLAY	fromField ROUTE name for SFBool field named bboxDisplay.
static final String	fromField_DESCRIPTION	fromField ROUTE name for SFString field named description.
static final String	fromField_ENABLED	fromField ROUTE name for SFBool field named enabled.
static final String	fromField_ENTITYID	fromField ROUTE name for SFInt32 field named entityID.
static final String	fromField_GEOCOORDS	fromField ROUTE name for SFVec3d field named geoCoords.
static final String	fromField_IS	fromField ROUTE name for SFNode field named IS.
static final String	fromField_ISACTIVE	fromField ROUTE name for SFBool field named isActive.
static final String	fromField_ISNETWORKREADER	fromField ROUTE name for SFBool field named isNetworkReader.
static final String	fromField_ISNETWORKWRITER	fromField ROUTE name for SFBool field named isNetworkWriter.
static final String	fromField_ISRTPHEADERHEARD	fromField ROUTE name for SFBool field named isRtpHeaderHeard.
static final String	fromField_ISSTANDALONE	fromField ROUTE name for SFBool field named isStandAlone.
static final String	fromField_METADATA	fromField ROUTE name for SFNode field named metadata.
static final String	fromField_MULTICASTRELAYHOST	fromField ROUTE name for SFString field named multicastRelayHost.
static final String	fromField_MULTICASTRELAYPORT	fromField ROUTE name for SFInt32 field named multicastRelayPort.
static final String	fromField_NETWORKMODE	fromField ROUTE name for SFString field named networkMode.
static final String	fromField_PORT	fromField ROUTE name for SFInt32 field named port.
static final String	fromField_RADIOID	fromField ROUTE name for SFInt32 field named radioID.
static final String	fromField_READINTERVAL	fromField ROUTE name for SFTime field named readInterval.
static final String	fromField_RECEIVEDPOWER	fromField ROUTE name for SFFloat field named receivedPower.
static final String	fromField_RECEIVERSTATE	fromField ROUTE name for SFInt32 field named receiverState.
static final String	fromField_RTPHEADEREXPECTED	fromField ROUTE name for SFBool field named rtpHeaderExpected.
static final String	fromField_SITEID	fromField ROUTE name for SFInt32 field named siteID.
static final String	fromField_TIMESTAMP	fromField ROUTE name for SFTime field named timestamp.
static final String	fromField_TRANSMITTERAPPLICATIONID	fromField ROUTE name for SFInt32 field named transmitterApplicationID.
static final String	fromField_TRANSMITTERENTITYID	fromField ROUTE name for SFInt32 field named transmitterEntityID.
static final String	fromField_TRANSMITTERRADIOID	fromField ROUTE name for SFInt32 field named transmitterRadioID.
static final String	fromField_TRANSMITTERSITEID	fromField ROUTE name for SFInt32 field named transmitterSiteID.
static final String	fromField_VISIBLE	fromField ROUTE name for SFBool field named visible.
static final String	fromField_WHICHGEOMETRY	fromField ROUTE name for SFInt32 field named whichGeometry.
static final String	fromField_WRITEINTERVAL	fromField ROUTE name for SFTime field named writeInterval.
static final double[]	GEOCOORDS_DEFAULT_VALUE	SFVec3d field named geoCoords has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax).
static final IS	IS_DEFAULT_VALUE	SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).
static final int	LEVEL	Integer constant LEVEL provides default X3D DIS component level for this element: 1
static final X3DMetadataObject	METADATA_DEFAULT_VALUE	SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).
static final String	MULTICASTRELAYHOST_DEFAULT_VALUE	SFString field named multicastRelayHost has default value equal to an empty string.
static final int	MULTICASTRELAYPORT_DEFAULT_VALUE	SFInt32 field named multicastRelayPort has default value 0 (Java syntax) or 0 (XML syntax).
static final String	NAME	String constant NAME provides name of this element: ReceiverPdu.
static final String	NETWORKMODE_DEFAULT_VALUE	SFString field named networkMode has default value "standAlone" (Java syntax) or standAlone (XML syntax).
static final String	NETWORKMODE_NETWORKREADER	Tooltip: listen to network and read PDU packets at readInterval, act as remotely linked copy of entity.
static final String	NETWORKMODE_NETWORKWRITER	Tooltip: send PDU packets to network at writeInterval, act as master entity.
static final String	NETWORKMODE_STANDALONE	Tooltip: ignore network but still respond to events in local scene.
static final int	PORT_DEFAULT_VALUE	SFInt32 field named port has default value 0 (Java syntax) or 0 (XML syntax).
static final int	RADIOID_DEFAULT_VALUE	SFInt32 field named radioID has default value 0 (Java syntax) or 0 (XML syntax).
static final double	READINTERVAL_DEFAULT_VALUE	SFTime field named readInterval has default value 0.1 (Java syntax) or 0.1 (XML syntax).
static final float	RECEIVEDPOWER_DEFAULT_VALUE	SFFloat field named receivedPower has default value 0.0f (Java syntax) or 0.0 (XML syntax).
static final int	RECEIVERSTATE_DEFAULT_VALUE	SFInt32 field named receiverState has default value 0 (Java syntax) or 0 (XML syntax).
static final boolean	RTPHEADEREXPECTED_DEFAULT_VALUE	SFBool field named rtpHeaderExpected has default value false (Java syntax) or false (XML syntax).
static final int	SITEID_DEFAULT_VALUE	SFInt32 field named siteID has default value 0 (Java syntax) or 0 (XML syntax).
static final String	toField_ADDRESS	toField ROUTE name for SFString field named address.
static final String	toField_APPLICATIONID	toField ROUTE name for SFInt32 field named applicationID.
static final String	toField_BBOXDISPLAY	toField ROUTE name for SFBool field named bboxDisplay.
static final String	toField_DESCRIPTION	toField ROUTE name for SFString field named description.
static final String	toField_ENABLED	toField ROUTE name for SFBool field named enabled.
static final String	toField_ENTITYID	toField ROUTE name for SFInt32 field named entityID.
static final String	toField_GEOCOORDS	toField ROUTE name for SFVec3d field named geoCoords.
static final String	toField_METADATA	toField ROUTE name for SFNode field named metadata.
static final String	toField_MULTICASTRELAYHOST	toField ROUTE name for SFString field named multicastRelayHost.
static final String	toField_MULTICASTRELAYPORT	toField ROUTE name for SFInt32 field named multicastRelayPort.
static final String	toField_NETWORKMODE	toField ROUTE name for SFString field named networkMode.
static final String	toField_PORT	toField ROUTE name for SFInt32 field named port.
static final String	toField_RADIOID	toField ROUTE name for SFInt32 field named radioID.
static final String	toField_READINTERVAL	toField ROUTE name for SFTime field named readInterval.
static final String	toField_RECEIVEDPOWER	toField ROUTE name for SFFloat field named receivedPower.
static final String	toField_RECEIVERSTATE	toField ROUTE name for SFInt32 field named receiverState.
static final String	toField_RTPHEADEREXPECTED	toField ROUTE name for SFBool field named rtpHeaderExpected.
static final String	toField_SITEID	toField ROUTE name for SFInt32 field named siteID.
static final String	toField_TRANSMITTERAPPLICATIONID	toField ROUTE name for SFInt32 field named transmitterApplicationID.
static final String	toField_TRANSMITTERENTITYID	toField ROUTE name for SFInt32 field named transmitterEntityID.
static final String	toField_TRANSMITTERRADIOID	toField ROUTE name for SFInt32 field named transmitterRadioID.
static final String	toField_TRANSMITTERSITEID	toField ROUTE name for SFInt32 field named transmitterSiteID.
static final String	toField_VISIBLE	toField ROUTE name for SFBool field named visible.
static final String	toField_WHICHGEOMETRY	toField ROUTE name for SFInt32 field named whichGeometry.
static final String	toField_WRITEINTERVAL	toField ROUTE name for SFTime field named writeInterval.
static final int	TRANSMITTERAPPLICATIONID_DEFAULT_VALUE	SFInt32 field named transmitterApplicationID has default value 0 (Java syntax) or 0 (XML syntax).
static final int	TRANSMITTERENTITYID_DEFAULT_VALUE	SFInt32 field named transmitterEntityID has default value 0 (Java syntax) or 0 (XML syntax).
static final int	TRANSMITTERRADIOID_DEFAULT_VALUE	SFInt32 field named transmitterRadioID has default value 0 (Java syntax) or 0 (XML syntax).
static final int	TRANSMITTERSITEID_DEFAULT_VALUE	SFInt32 field named transmitterSiteID has default value 0 (Java syntax) or 0 (XML syntax).
static final boolean	VISIBLE_DEFAULT_VALUE	SFBool field named visible has default value true (Java syntax) or true (XML syntax).
static final int	WHICHGEOMETRY_DEFAULT_VALUE	SFInt32 field named whichGeometry has default value 1 (Java syntax) or 1 (XML syntax).
static final double	WRITEINTERVAL_DEFAULT_VALUE	SFTime field named writeInterval has default value 1.0 (Java syntax) or 1.0 (XML syntax).

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteNode

containerField_ALLOWED_VALUES, containerFieldOverride

Fields inherited from class org.web3d.x3d.jsail.X3DConcreteElement

validationResult

Constructor Summary

Constructors

Constructor	Description
ReceiverPdu()	Constructor for ReceiverPdu to initialize member variables with default values.
ReceiverPdu(String DEFlabel)	Utility constructor that assigns DEF label after initializing member variables with default values.

Method Summary

Modifier and Type	Method	Description
ReceiverPdu	addComments(String newComment)	Add comment as String to contained commentsList.
ReceiverPdu	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
ReceiverPdu	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
ReceiverPdu	addGeoSystem(String newValue)	Add singleton String value to MFString geoSystem field, not allowing duplicate or empty string values in this controlled enumeration field.
ReceiverPdu	addGeoSystem(SFString newValue)	Add singleton SFString value to MFString geoSystem field, not allowing duplicate or empty string values in this controlled enumeration field.
ReceiverPdu	clearGeoSystem()	Utility method to clear MFString value of geoSystem field.
ReceiverPdu	clearIS()	Utility method to clear SFNode value of IS field.
ReceiverPdu	clearMetadata()	Utility method to clear SFNode value of metadata field.
X3DConcreteElement	findElementByNameValue(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.
X3DConcreteElement	findElementByNameValue(String nameValue, 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.
X3DConcreteNode	findNodeByDEF(String DEFvalue)	Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
String	getAccessType(String fieldName)	Indicate accessType corresponding to given fieldName.
String	getAddress()	Provide String value from inputOutput SFString field named address.
static final String	getAddressDefault()	Public accessor for encapsulated SFString default value "localhost", returned as String.
int	getApplicationID()	Provide int value from inputOutput SFInt32 field named applicationID.
static final int	getApplicationIDDefault()	Public accessor for encapsulated SFInt32 default value 0, returned as int.
float[]	getBboxCenter()	Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
static final float[]	getBboxCenterDefault()	Public accessor for encapsulated SFVec3f default value {0f,0f,0f}, returned as float array.
boolean	getBboxDisplay()	Provide boolean value from inputOutput SFBool field named bboxDisplay.
static final boolean	getBboxDisplayDefault()	Public accessor for encapsulated SFBool default value false, returned as boolean.
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.
static final float[]	getBboxSizeDefault()	Public accessor for encapsulated SFVec3f default value {-1f,-1f,-1f}, returned as float array.
final String	getComponent()	Defines X3D component for the ReceiverPdu element: DIS
final int	getComponentLevel()	Provides default X3D component level for this element: 1
final String	getContainerFieldDefault()	containerField describes typical field relationship of a node to its parent.
String	getCssClass()	Provide String value from inputOutput SFString field named class.
String	getCssStyle()	Provide String value from inputOutput SFString field named style.
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
String	getDescription()	Provide String value from inputOutput SFString field named description.
static final String	getDescriptionDefault()	Public accessor for encapsulated SFString default value, returned as String.
final String	getElementName()	Provides name of this element: ReceiverPdu
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
static final boolean	getEnabledDefault()	Public accessor for encapsulated SFBool default value true, returned as boolean.
int	getEntityID()	Provide int value from inputOutput SFInt32 field named entityID.
static final int	getEntityIDDefault()	Public accessor for encapsulated SFInt32 default value 0, returned as int.
String	getFieldType(String fieldName)	Indicate type corresponding to given fieldName.
double[]	getGeoCoords()	Provide array of 3-tuple double results from inputOutput SFVec3d field named geoCoords.
static final double[]	getGeoCoordsDefault()	Public accessor for encapsulated SFVec3d default value {0,0,0}, returned as double array.
String[]	getGeoSystem()	Provide array of String results from initializeOnly MFString field named geoSystem.
static final String[]	getGeoSystemDefault()	Public accessor for encapsulated MFString default value new String[] {"GD","WE") array, returned as String array.
static final ArrayList<String>	getGeoSystemDefaultList()	Public accessor for encapsulated MFString default value new String[] {"GD","WE"), returned as ArrayList
ArrayList<String>	getGeoSystemList()	Utility method to get ArrayList value of MFString geoSystem field, similar to getGeoSystem().
String	getGeoSystemString()	Utility method to get String value of MFString geoSystem field, similar to getGeoSystem().
String	getHtmlId()	Provide String value from inputOutput SFString field named id.
IS	getIS()	Provide IS instance (using a properly typed node) from inputOutput SFNode field IS.
boolean	getIsActive()	Provide boolean value from outputOnly SFBool field named isActive.
static final IS	getISDefault()	Public accessor for encapsulated SFNode default value null, returned as IS.
boolean	getIsNetworkReader()	Provide boolean value from outputOnly SFBool field named isNetworkReader.
boolean	getIsNetworkWriter()	Provide boolean value from outputOnly SFBool field named isNetworkWriter.
boolean	getIsRtpHeaderHeard()	Provide boolean value from outputOnly SFBool field named isRtpHeaderHeard.
boolean	getIsStandAlone()	Provide boolean value from outputOnly SFBool field named isStandAlone.
X3DMetadataObject	getMetadata()	Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
static final X3DMetadataObject	getMetadataDefault()	Public accessor for encapsulated SFNode default value null, returned as org.web3d.x3d.sai.Core.X3DMetadataObject.
String	getMulticastRelayHost()	Provide String value from inputOutput SFString field named multicastRelayHost.
static final String	getMulticastRelayHostDefault()	Public accessor for encapsulated SFString default value, returned as String.
int	getMulticastRelayPort()	Provide int value from inputOutput SFInt32 field named multicastRelayPort.
static final int	getMulticastRelayPortDefault()	Public accessor for encapsulated SFInt32 default value 0, returned as int.
String	getNetworkMode()	Provide String enumeration value (baseType xs:NMTOKEN) ["standAlone" | "networkReader" | "networkWriter"] from inputOutput SFString field named networkMode.
static final String	getNetworkModeDefault()	Public accessor for encapsulated SFString default value "standAlone", returned as String.
int	getPort()	Provide int value from inputOutput SFInt32 field named port.
static final int	getPortDefault()	Public accessor for encapsulated SFInt32 default value 0, returned as int.
int	getRadioID()	Provide int value from inputOutput SFInt32 field named radioID.
static final int	getRadioIDDefault()	Public accessor for encapsulated SFInt32 default value 0, returned as int.
double	getReadInterval()	Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named readInterval.
static final double	getReadIntervalDefault()	Public accessor for encapsulated SFTime default value 0.1, returned as double.
float	getReceivedPower()	Provide float value from inputOutput SFFloat field named receivedPower.
static final float	getReceivedPowerDefault()	Public accessor for encapsulated SFFloat default value 0.0f, returned as float.
int	getReceiverState()	Provide int value from inputOutput SFInt32 field named receiverState.
static final int	getReceiverStateDefault()	Public accessor for encapsulated SFInt32 default value 0, returned as int.
boolean	getRtpHeaderExpected()	Provide boolean value from inputOutput SFBool field named rtpHeaderExpected.
static final boolean	getRtpHeaderExpectedDefault()	Public accessor for encapsulated SFBool default value false, returned as boolean.
int	getSiteID()	Provide int value from inputOutput SFInt32 field named siteID.
static final int	getSiteIDDefault()	Public accessor for encapsulated SFInt32 default value 0, returned as int.
double	getTimestamp()	Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named timestamp.
int	getTransmitterApplicationID()	Provide int value from inputOutput SFInt32 field named transmitterApplicationID.
static final int	getTransmitterApplicationIDDefault()	Public accessor for encapsulated SFInt32 default value 0, returned as int.
int	getTransmitterEntityID()	Provide int value from inputOutput SFInt32 field named transmitterEntityID.
static final int	getTransmitterEntityIDDefault()	Public accessor for encapsulated SFInt32 default value 0, returned as int.
int	getTransmitterRadioID()	Provide int value from inputOutput SFInt32 field named transmitterRadioID.
static final int	getTransmitterRadioIDDefault()	Public accessor for encapsulated SFInt32 default value 0, returned as int.
int	getTransmitterSiteID()	Provide int value from inputOutput SFInt32 field named transmitterSiteID.
static final int	getTransmitterSiteIDDefault()	Public accessor for encapsulated SFInt32 default value 0, returned as int.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	getVisible()	Provide boolean value from inputOutput SFBool field named visible.
static final boolean	getVisibleDefault()	Public accessor for encapsulated SFBool default value true, returned as boolean.
int	getWhichGeometry()	Provide int value from inputOutput SFInt32 field named whichGeometry.
static final int	getWhichGeometryDefault()	Public accessor for encapsulated SFInt32 default value 1, returned as int.
double	getWriteInterval()	Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named writeInterval.
static final double	getWriteIntervalDefault()	Public accessor for encapsulated SFTime default value 1.0, returned as double.
boolean	hasElementByNameValue(String nameValue, 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.
boolean	hasIS()	Indicate whether an object is available for inputOutput SFNode field IS.
boolean	hasMetadata()	Indicate whether an object is available for inputOutput SFNode field metadata.
boolean	hasNodeByDEF(String DEFvalue)	Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.
final void	initialize()	Initialize all member variables to default values.
ReceiverPdu	setAddress(String newValue)	Accessor method to assign String value to inputOutput SFString field named address.
ReceiverPdu	setAddress(SFString newValue)	Assign typed object value to SFString address field, similar to setAddress(String).
ReceiverPdu	setApplicationID(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named applicationID.
ReceiverPdu	setApplicationID(SFInt32 newValue)	Assign typed object value to SFInt32 applicationID field, similar to setApplicationID(int).
ReceiverPdu	setBboxCenter(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).
ReceiverPdu	setBboxCenter(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).
ReceiverPdu	setBboxCenter(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
ReceiverPdu	setBboxCenter(float x, float y, float z)	Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
ReceiverPdu	setBboxCenter(SFVec3f newValue)	Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
ReceiverPdu	setBboxDisplay(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
ReceiverPdu	setBboxDisplay(SFBool newValue)	Assign typed object value to SFBool bboxDisplay field, similar to setBboxDisplay(boolean).
ReceiverPdu	setBboxSize(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).
ReceiverPdu	setBboxSize(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).
ReceiverPdu	setBboxSize(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
ReceiverPdu	setBboxSize(float x, float y, float z)	Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
ReceiverPdu	setBboxSize(SFVec3f newValue)	Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
final ReceiverPdu	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
ReceiverPdu	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final ReceiverPdu	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
ReceiverPdu	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
final ReceiverPdu	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
ReceiverPdu	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
ReceiverPdu	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
ReceiverPdu	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
ReceiverPdu	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
ReceiverPdu	setEnabled(SFBool newValue)	Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
ReceiverPdu	setEntityID(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named entityID.
ReceiverPdu	setEntityID(SFInt32 newValue)	Assign typed object value to SFInt32 entityID field, similar to setEntityID(int).
ReceiverPdu	setGeoCoords(double[] newValue)	Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named geoCoords.
ReceiverPdu	setGeoCoords(double x, double y, double z)	Assign values to SFVec3d geoCoords field, similar to setGeoCoords(double[]).
ReceiverPdu	setGeoCoords(SFVec3d newValue)	Assign typed object value to SFVec3d geoCoords field, similar to setGeoCoords(double[]).
ReceiverPdu	setGeoSystem(String newValue)	Assign singleton String value to MFString geoSystem field, similar to setGeoSystem(String[]).
ReceiverPdu	setGeoSystem(String[] newValue)	Accessor method to assign String array to initializeOnly MFString field named geoSystem.
ReceiverPdu	setGeoSystem(ArrayList<String> newValue)	Assign ArrayList value of MFString geoSystem field, similar to setGeoSystem(String[]).
ReceiverPdu	setGeoSystem(MFString newValue)	Assign typed object value to MFString geoSystem field, similar to setGeoSystem(String[]).
ReceiverPdu	setGeoSystem(SFString newValue)	Assign single SFString object value to MFString geoSystem field, similar to setGeoSystem(String[]).
final ReceiverPdu	setHtmlId(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
ReceiverPdu	setHtmlId(SFString newValue)	Assign typed object value to SFString HtmlId field, similar to setHtmlId(String).
ReceiverPdu	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
ReceiverPdu	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
ReceiverPdu	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
ReceiverPdu	setMulticastRelayHost(String newValue)	Accessor method to assign String value to inputOutput SFString field named multicastRelayHost.
ReceiverPdu	setMulticastRelayHost(SFString newValue)	Assign typed object value to SFString multicastRelayHost field, similar to setMulticastRelayHost(String).
ReceiverPdu	setMulticastRelayPort(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named multicastRelayPort.
ReceiverPdu	setMulticastRelayPort(SFInt32 newValue)	Assign typed object value to SFInt32 multicastRelayPort field, similar to setMulticastRelayPort(int).
ReceiverPdu	setNetworkMode(String newValue)	Accessor method to assign String enumeration value ("standAlone" | "networkReader" | "networkWriter") to inputOutput SFString field named networkMode.
ReceiverPdu	setNetworkMode(SFString newValue)	Assign typed object value to SFString networkMode field, similar to setNetworkMode(String).
ReceiverPdu	setPort(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named port.
ReceiverPdu	setPort(SFInt32 newValue)	Assign typed object value to SFInt32 port field, similar to setPort(int).
ReceiverPdu	setRadioID(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named radioID.
ReceiverPdu	setRadioID(SFInt32 newValue)	Assign typed object value to SFInt32 radioID field, similar to setRadioID(int).
ReceiverPdu	setReadInterval(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named readInterval.
ReceiverPdu	setReadInterval(SFTime newValue)	Assign typed object value to SFTime readInterval field, similar to setReadInterval(double).
ReceiverPdu	setReceivedPower(double newValue)	Utility method: double-precision set-parameter accessor for X3D floating-point type, similar to setReceivedPower(float).
ReceiverPdu	setReceivedPower(float newValue)	Accessor method to assign float value to inputOutput SFFloat field named receivedPower.
ReceiverPdu	setReceivedPower(SFFloat newValue)	Assign typed object value to SFFloat receivedPower field, similar to setReceivedPower(float).
ReceiverPdu	setReceiverState(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named receiverState.
ReceiverPdu	setReceiverState(SFInt32 newValue)	Assign typed object value to SFInt32 receiverState field, similar to setReceiverState(int).
ReceiverPdu	setRtpHeaderExpected(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named rtpHeaderExpected.
ReceiverPdu	setRtpHeaderExpected(SFBool newValue)	Assign typed object value to SFBool rtpHeaderExpected field, similar to setRtpHeaderExpected(boolean).
ReceiverPdu	setSiteID(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named siteID.
ReceiverPdu	setSiteID(SFInt32 newValue)	Assign typed object value to SFInt32 siteID field, similar to setSiteID(int).
ReceiverPdu	setTransmitterApplicationID(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named transmitterApplicationID.
ReceiverPdu	setTransmitterApplicationID(SFInt32 newValue)	Assign typed object value to SFInt32 transmitterApplicationID field, similar to setTransmitterApplicationID(int).
ReceiverPdu	setTransmitterEntityID(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named transmitterEntityID.
ReceiverPdu	setTransmitterEntityID(SFInt32 newValue)	Assign typed object value to SFInt32 transmitterEntityID field, similar to setTransmitterEntityID(int).
ReceiverPdu	setTransmitterRadioID(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named transmitterRadioID.
ReceiverPdu	setTransmitterRadioID(SFInt32 newValue)	Assign typed object value to SFInt32 transmitterRadioID field, similar to setTransmitterRadioID(int).
ReceiverPdu	setTransmitterSiteID(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named transmitterSiteID.
ReceiverPdu	setTransmitterSiteID(SFInt32 newValue)	Assign typed object value to SFInt32 transmitterSiteID field, similar to setTransmitterSiteID(int).
final ReceiverPdu	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
ReceiverPdu	setUSE(ReceiverPdu DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
ReceiverPdu	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
ReceiverPdu	setVisible(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named visible.
ReceiverPdu	setVisible(SFBool newValue)	Assign typed object value to SFBool visible field, similar to setVisible(boolean).
ReceiverPdu	setWhichGeometry(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named whichGeometry.
ReceiverPdu	setWhichGeometry(SFInt32 newValue)	Assign typed object value to SFInt32 whichGeometry field, similar to setWhichGeometry(int).
ReceiverPdu	setWriteInterval(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named writeInterval.
ReceiverPdu	setWriteInterval(SFTime newValue)	Assign typed object value to SFTime writeInterval field, similar to setWriteInterval(double).
String	toStringClassicVRML(int indentLevel)	Recursive method to provide ClassicVRML string serialization.
String	toStringVRML97(int indentLevel)	Recursive method to provide VRML97 string serialization.
String	toStringX3D(int indentLevel)	Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.
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.

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode

getContainerFieldAllowedValues, getContainerFieldOverride, getDEFDefault, getName, getUSEDefault, hasDEF, hasNameField, hasUSE, includesNameField, isNode, isStatement, resetContainerFieldOverride, setConcreteDEF, setConcreteUSE, setContainerFieldOverride

Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement

addComments, clearParent, findAncestorElementByName, findAncestorProtoBody, findAncestorScene, findAncestorX3D, getCssClassDefault, getCssStyleDefault, getHtmlIdDefault, getPackageName, getParent, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorScene, hasAncestorX3D, hasParent, isValid, setConcreteCssClass, setConcreteCssStyle, setConcreteHtmlId, setParent, toStringClassicVRML, toStringVRML97, toStringX3D

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NETWORKMODE_STANDALONE

public static final String NETWORKMODE_STANDALONE

Tooltip: ignore network but still respond to events in local scene. SFString field named networkMode with X3DUOM simpleType networkModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "standAlone" (Java syntax) or standAlone (XML syntax).

See Also:

• XML Schema: networkModeChoices
• Constant Field Values

NETWORKMODE_NETWORKREADER

public static final String NETWORKMODE_NETWORKREADER

Tooltip: listen to network and read PDU packets at readInterval, act as remotely linked copy of entity. SFString field named networkMode with X3DUOM simpleType networkModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "networkReader" (Java syntax) or networkReader (XML syntax).

See Also:

• XML Schema: networkModeChoices
• Constant Field Values

NETWORKMODE_NETWORKWRITER

public static final String NETWORKMODE_NETWORKWRITER

Tooltip: send PDU packets to network at writeInterval, act as master entity. SFString field named networkMode with X3DUOM simpleType networkModeChoices and with X3DUOM baseType xs:NMTOKEN can equal this value "networkWriter" (Java syntax) or networkWriter (XML syntax).

See Also:

• XML Schema: networkModeChoices
• Constant Field Values

NAME

public static final String NAME

String constant NAME provides name of this element: ReceiverPdu.

See Also:

• Constant Field Values

COMPONENT

public static final 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 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).

BBOXDISPLAY_DEFAULT_VALUE

public static final boolean BBOXDISPLAY_DEFAULT_VALUE

SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).

See Also:

• Constant Field Values

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

DESCRIPTION_DEFAULT_VALUE

public static final String DESCRIPTION_DEFAULT_VALUE

SFString field named description has default value equal to an empty string.

See Also:

• Constant Field Values

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

IS_DEFAULT_VALUE

public static final IS 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 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 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

VISIBLE_DEFAULT_VALUE

public static final boolean VISIBLE_DEFAULT_VALUE

SFBool field named visible has default value true (Java syntax) or true (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

containerField_DEFAULT_VALUE

public static final String containerField_DEFAULT_VALUE

containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, this default value is provided for informational purposes only.
containerField_DEFAULT_VALUE = "children";
containerField_ALLOWED_VALUES = {"children" }; type xs:NMTOKEN

See Also:

• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for containerField
• X3D Unified Object Model (X3DUOM)
• Constant Field Values

fromField_ADDRESS

public static final String fromField_ADDRESS

fromField ROUTE name for SFString field named address.

See Also:

• Constant Field Values

toField_ADDRESS

public static final String toField_ADDRESS

toField ROUTE name for SFString field named address.

See Also:

• Constant Field Values

fromField_APPLICATIONID

public static final String fromField_APPLICATIONID

fromField ROUTE name for SFInt32 field named applicationID.

See Also:

• Constant Field Values

toField_APPLICATIONID

public static final String toField_APPLICATIONID

toField ROUTE name for SFInt32 field named applicationID.

See Also:

• Constant Field Values

fromField_BBOXDISPLAY

public static final String fromField_BBOXDISPLAY

fromField ROUTE name for SFBool field named bboxDisplay.

See Also:

• Constant Field Values

toField_BBOXDISPLAY

public static final String toField_BBOXDISPLAY

toField ROUTE name for SFBool field named bboxDisplay.

See Also:

• Constant Field Values

fromField_DESCRIPTION

public static final String fromField_DESCRIPTION

fromField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

toField_DESCRIPTION

public static final String toField_DESCRIPTION

toField ROUTE name for SFString field named description.

See Also:

• Constant Field Values

fromField_ENABLED

public static final String fromField_ENABLED

fromField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

toField_ENABLED

public static final String toField_ENABLED

toField ROUTE name for SFBool field named enabled.

See Also:

• Constant Field Values

fromField_ENTITYID

public static final String fromField_ENTITYID

fromField ROUTE name for SFInt32 field named entityID.

See Also:

• Constant Field Values

toField_ENTITYID

public static final String toField_ENTITYID

toField ROUTE name for SFInt32 field named entityID.

See Also:

• Constant Field Values

fromField_GEOCOORDS

public static final String fromField_GEOCOORDS

fromField ROUTE name for SFVec3d field named geoCoords.

See Also:

• Constant Field Values

toField_GEOCOORDS

public static final String toField_GEOCOORDS

toField ROUTE name for SFVec3d field named geoCoords.

See Also:

• Constant Field Values

fromField_IS

public static final String fromField_IS

fromField ROUTE name for SFNode field named IS.

See Also:

• Constant Field Values

fromField_ISACTIVE

public static final String fromField_ISACTIVE

fromField ROUTE name for SFBool field named isActive.

See Also:

• Constant Field Values

fromField_ISNETWORKREADER

public static final String fromField_ISNETWORKREADER

fromField ROUTE name for SFBool field named isNetworkReader.

See Also:

• Constant Field Values

fromField_ISNETWORKWRITER

public static final String fromField_ISNETWORKWRITER

fromField ROUTE name for SFBool field named isNetworkWriter.

See Also:

• Constant Field Values

fromField_ISRTPHEADERHEARD

public static final String fromField_ISRTPHEADERHEARD

fromField ROUTE name for SFBool field named isRtpHeaderHeard.

See Also:

• Constant Field Values

fromField_ISSTANDALONE

public static final String fromField_ISSTANDALONE

fromField ROUTE name for SFBool field named isStandAlone.

See Also:

• Constant Field Values

fromField_METADATA

public static final String fromField_METADATA

fromField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

toField_METADATA

public static final String toField_METADATA

toField ROUTE name for SFNode field named metadata.

See Also:

• Constant Field Values

fromField_MULTICASTRELAYHOST

public static final String fromField_MULTICASTRELAYHOST

fromField ROUTE name for SFString field named multicastRelayHost.

See Also:

• Constant Field Values

toField_MULTICASTRELAYHOST

public static final String toField_MULTICASTRELAYHOST

toField ROUTE name for SFString field named multicastRelayHost.

See Also:

• Constant Field Values

fromField_MULTICASTRELAYPORT

public static final String fromField_MULTICASTRELAYPORT

fromField ROUTE name for SFInt32 field named multicastRelayPort.

See Also:

• Constant Field Values

toField_MULTICASTRELAYPORT

public static final String toField_MULTICASTRELAYPORT

toField ROUTE name for SFInt32 field named multicastRelayPort.

See Also:

• Constant Field Values

fromField_NETWORKMODE

public static final String fromField_NETWORKMODE

fromField ROUTE name for SFString field named networkMode.

See Also:

• Constant Field Values

toField_NETWORKMODE

public static final String toField_NETWORKMODE

toField ROUTE name for SFString field named networkMode.

See Also:

• Constant Field Values

fromField_PORT

public static final String fromField_PORT

fromField ROUTE name for SFInt32 field named port.

See Also:

• Constant Field Values

toField_PORT

public static final String toField_PORT

toField ROUTE name for SFInt32 field named port.

See Also:

• Constant Field Values

fromField_RADIOID

public static final String fromField_RADIOID

fromField ROUTE name for SFInt32 field named radioID.

See Also:

• Constant Field Values

toField_RADIOID

public static final String toField_RADIOID

toField ROUTE name for SFInt32 field named radioID.

See Also:

• Constant Field Values

fromField_READINTERVAL

public static final String fromField_READINTERVAL

fromField ROUTE name for SFTime field named readInterval.

See Also:

• Constant Field Values

toField_READINTERVAL

public static final String toField_READINTERVAL

toField ROUTE name for SFTime field named readInterval.

See Also:

• Constant Field Values

fromField_RECEIVEDPOWER

public static final String fromField_RECEIVEDPOWER

fromField ROUTE name for SFFloat field named receivedPower.

See Also:

• Constant Field Values

toField_RECEIVEDPOWER

public static final String toField_RECEIVEDPOWER

toField ROUTE name for SFFloat field named receivedPower.

See Also:

• Constant Field Values

fromField_RECEIVERSTATE

public static final String fromField_RECEIVERSTATE

fromField ROUTE name for SFInt32 field named receiverState.

See Also:

• Constant Field Values

toField_RECEIVERSTATE

public static final String toField_RECEIVERSTATE

toField ROUTE name for SFInt32 field named receiverState.

See Also:

• Constant Field Values

fromField_RTPHEADEREXPECTED

public static final String fromField_RTPHEADEREXPECTED

fromField ROUTE name for SFBool field named rtpHeaderExpected.

See Also:

• Constant Field Values

toField_RTPHEADEREXPECTED

public static final String toField_RTPHEADEREXPECTED

toField ROUTE name for SFBool field named rtpHeaderExpected.

See Also:

• Constant Field Values

fromField_SITEID

public static final String fromField_SITEID

fromField ROUTE name for SFInt32 field named siteID.

See Also:

• Constant Field Values

toField_SITEID

public static final String toField_SITEID

toField ROUTE name for SFInt32 field named siteID.

See Also:

• Constant Field Values

fromField_TIMESTAMP

public static final String fromField_TIMESTAMP

fromField ROUTE name for SFTime field named timestamp.

See Also:

• Constant Field Values

fromField_TRANSMITTERAPPLICATIONID

public static final String fromField_TRANSMITTERAPPLICATIONID

fromField ROUTE name for SFInt32 field named transmitterApplicationID.

See Also:

• Constant Field Values

toField_TRANSMITTERAPPLICATIONID

public static final String toField_TRANSMITTERAPPLICATIONID

toField ROUTE name for SFInt32 field named transmitterApplicationID.

See Also:

• Constant Field Values

fromField_TRANSMITTERENTITYID

public static final String fromField_TRANSMITTERENTITYID

fromField ROUTE name for SFInt32 field named transmitterEntityID.

See Also:

• Constant Field Values

toField_TRANSMITTERENTITYID

public static final String toField_TRANSMITTERENTITYID

toField ROUTE name for SFInt32 field named transmitterEntityID.

See Also:

• Constant Field Values

fromField_TRANSMITTERRADIOID

public static final String fromField_TRANSMITTERRADIOID

fromField ROUTE name for SFInt32 field named transmitterRadioID.

See Also:

• Constant Field Values

toField_TRANSMITTERRADIOID

public static final String toField_TRANSMITTERRADIOID

toField ROUTE name for SFInt32 field named transmitterRadioID.

See Also:

• Constant Field Values

fromField_TRANSMITTERSITEID

public static final String fromField_TRANSMITTERSITEID

fromField ROUTE name for SFInt32 field named transmitterSiteID.

See Also:

• Constant Field Values

toField_TRANSMITTERSITEID

public static final String toField_TRANSMITTERSITEID

toField ROUTE name for SFInt32 field named transmitterSiteID.

See Also:

• Constant Field Values

fromField_VISIBLE

public static final String fromField_VISIBLE

fromField ROUTE name for SFBool field named visible.

See Also:

• Constant Field Values

toField_VISIBLE

public static final String toField_VISIBLE

toField ROUTE name for SFBool field named visible.

See Also:

• Constant Field Values

fromField_WHICHGEOMETRY

public static final String fromField_WHICHGEOMETRY

fromField ROUTE name for SFInt32 field named whichGeometry.

See Also:

• Constant Field Values

toField_WHICHGEOMETRY

public static final String toField_WHICHGEOMETRY

toField ROUTE name for SFInt32 field named whichGeometry.

See Also:

• Constant Field Values

fromField_WRITEINTERVAL

public static final String fromField_WRITEINTERVAL

fromField ROUTE name for SFTime field named writeInterval.

See Also:

• Constant Field Values

toField_WRITEINTERVAL

public static final String toField_WRITEINTERVAL

toField ROUTE name for SFTime field named writeInterval.

See Also:

• Constant Field Values

Constructor Details

ReceiverPdu

public ReceiverPdu()

Constructor for ReceiverPdu to initialize member variables with default values.

ReceiverPdu

public ReceiverPdu(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 String getElementName()

Provides name of this element: ReceiverPdu

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

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

getAddressDefault

public static final String getAddressDefault()

Public accessor for encapsulated SFString default value "localhost", returned as String.

Returns:

default value

getApplicationIDDefault

public static final int getApplicationIDDefault()

Public accessor for encapsulated SFInt32 default value 0, returned as int.

Returns:

default value

getBboxCenterDefault

public static final float[] getBboxCenterDefault()

Public accessor for encapsulated SFVec3f default value {0f,0f,0f}, returned as float array.

Returns:

default value

getBboxDisplayDefault

public static final boolean getBboxDisplayDefault()

Public accessor for encapsulated SFBool default value false, returned as boolean.

Returns:

default value

getBboxSizeDefault

public static final float[] getBboxSizeDefault()

Public accessor for encapsulated SFVec3f default value {-1f,-1f,-1f}, returned as float array.

Returns:

default value

getDescriptionDefault

public static final String getDescriptionDefault()

Public accessor for encapsulated SFString default value, returned as String.

Returns:

default value

getEnabledDefault

public static final boolean getEnabledDefault()

Public accessor for encapsulated SFBool default value true, returned as boolean.

Returns:

default value

getEntityIDDefault

public static final int getEntityIDDefault()

Public accessor for encapsulated SFInt32 default value 0, returned as int.

Returns:

default value

getGeoCoordsDefault

public static final double[] getGeoCoordsDefault()

Public accessor for encapsulated SFVec3d default value {0,0,0}, returned as double array.

Returns:

default value

getGeoSystemDefault

public static final String[] getGeoSystemDefault()

Public accessor for encapsulated MFString default value new String[] {"GD","WE") array, returned as String array.

Returns:

default value

getGeoSystemDefaultList

public static final ArrayList<String> getGeoSystemDefaultList()

Public accessor for encapsulated MFString default value new String[] {"GD","WE"), returned as ArrayList

Returns:

default value

getISDefault

public static final IS getISDefault()

Public accessor for encapsulated SFNode default value null, returned as IS.

Returns:

default value

getMetadataDefault

public static final X3DMetadataObject getMetadataDefault()

Public accessor for encapsulated SFNode default value null, returned as org.web3d.x3d.sai.Core.X3DMetadataObject.

Returns:

default value

getMulticastRelayHostDefault

public static final String getMulticastRelayHostDefault()

Public accessor for encapsulated SFString default value, returned as String.

Returns:

default value

getMulticastRelayPortDefault

public static final int getMulticastRelayPortDefault()

Public accessor for encapsulated SFInt32 default value 0, returned as int.

Returns:

default value

getNetworkModeDefault

public static final String getNetworkModeDefault()

Public accessor for encapsulated SFString default value "standAlone", returned as String.

Returns:

default value

getPortDefault

public static final int getPortDefault()

Public accessor for encapsulated SFInt32 default value 0, returned as int.

Returns:

default value

getRadioIDDefault

public static final int getRadioIDDefault()

Public accessor for encapsulated SFInt32 default value 0, returned as int.

Returns:

default value

getReadIntervalDefault

public static final double getReadIntervalDefault()

Public accessor for encapsulated SFTime default value 0.1, returned as double.

Returns:

default value

getReceivedPowerDefault

public static final float getReceivedPowerDefault()

Public accessor for encapsulated SFFloat default value 0.0f, returned as float.

Returns:

default value

getReceiverStateDefault

public static final int getReceiverStateDefault()

Public accessor for encapsulated SFInt32 default value 0, returned as int.

Returns:

default value

getRtpHeaderExpectedDefault

public static final boolean getRtpHeaderExpectedDefault()

Public accessor for encapsulated SFBool default value false, returned as boolean.

Returns:

default value

getSiteIDDefault

public static final int getSiteIDDefault()

Public accessor for encapsulated SFInt32 default value 0, returned as int.

Returns:

default value

getTransmitterApplicationIDDefault

public static final int getTransmitterApplicationIDDefault()

Public accessor for encapsulated SFInt32 default value 0, returned as int.

Returns:

default value

getTransmitterEntityIDDefault

public static final int getTransmitterEntityIDDefault()

Public accessor for encapsulated SFInt32 default value 0, returned as int.

Returns:

default value

getTransmitterRadioIDDefault

public static final int getTransmitterRadioIDDefault()

Public accessor for encapsulated SFInt32 default value 0, returned as int.

Returns:

default value

getTransmitterSiteIDDefault

public static final int getTransmitterSiteIDDefault()

Public accessor for encapsulated SFInt32 default value 0, returned as int.

Returns:

default value

getVisibleDefault

public static final boolean getVisibleDefault()

Public accessor for encapsulated SFBool default value true, returned as boolean.

Returns:

default value

getWhichGeometryDefault

public static final int getWhichGeometryDefault()

Public accessor for encapsulated SFInt32 default value 1, returned as int.

Returns:

default value

getWriteIntervalDefault

public static final double getWriteIntervalDefault()

Public accessor for encapsulated SFTime default value 1.0, returned as double.

Returns:

default value

getFieldType

public String getFieldType(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 String getAccessType(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 String getContainerFieldDefault()

containerField describes typical field relationship of a node to its parent. Programmer usage is not ordinarily needed when using this API, since this default value is provided for informational purposes only.

Specified by:

getContainerFieldDefault in class X3DConcreteNode

Returns:

default containerField value

See Also:

• containerField_DEFAULT_VALUE
• X3DConcreteNode.containerField_ALLOWED_VALUES
• X3D Scene Authoring Hints: containerField
• X3D Scene Authoring Hints: validation choices for 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 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 ReceiverPdu setAddress(String newValue)

Accessor method to assign String value to inputOutput SFString field named address.

Tooltip: Multicast network address, or else 'localhost'; Example: 224.2.181.145. *

Specified by:

setAddress in interface ReceiverPdu

Parameters:

newValue - is new value for the address field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setAddress

public ReceiverPdu setAddress(SFString newValue)

Assign typed object value to SFString address field, similar to setAddress(String).

Parameters:

newValue - is new value for the address field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getApplicationID

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 ReceiverPdu setApplicationID(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named applicationID.

Tooltip: Each simulation application that can respond to simulation management PDUs needs to have a unique applicationID. *

Specified by:

setApplicationID in interface ReceiverPdu

Parameters:

newValue - is new value for the applicationID field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setApplicationID

public ReceiverPdu setApplicationID(SFInt32 newValue)

Assign typed object value to SFInt32 applicationID field, similar to setApplicationID(int).

Parameters:

newValue - is new value for the applicationID field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getBboxCenter

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.

• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject

Specified by:

getBboxCenter in interface ReceiverPdu

Specified by:

getBboxCenter in interface X3DBoundedObject

Returns:

value of bboxCenter field

setBboxCenter

public ReceiverPdu setBboxCenter(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.

Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.

• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject

Specified by:

setBboxCenter in interface ReceiverPdu

Specified by:

setBboxCenter in interface X3DBoundedObject

Parameters:

newValue - is new value for the bboxCenter field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxCenter

public ReceiverPdu setBboxCenter(SFVec3f newValue)

Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).

Parameters:

newValue - is new value for the bboxCenter field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxCenter

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

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxCenter

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

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxCenter

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

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getBboxDisplay

public boolean getBboxDisplay()

Provide boolean value from inputOutput SFBool field named bboxDisplay.

Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.

• Hint: the bounding box is displayed regardless of whether contained content is visible.

Specified by:

getBboxDisplay in interface ReceiverPdu

Specified by:

getBboxDisplay in interface X3DBoundedObject

Returns:

value of bboxDisplay field

setBboxDisplay

public ReceiverPdu setBboxDisplay(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.

Tooltip: Whether to display bounding box for associated geometry, aligned with world coordinates.

• Hint: the bounding box is displayed regardless of whether contained content is visible.

Specified by:

setBboxDisplay in interface ReceiverPdu

Specified by:

setBboxDisplay in interface X3DBoundedObject

Parameters:

newValue - is new value for the bboxDisplay field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxDisplay

public ReceiverPdu setBboxDisplay(SFBool newValue)

Assign typed object value to SFBool bboxDisplay field, similar to setBboxDisplay(boolean).

Parameters:

newValue - is new value for the bboxDisplay field.

Returns:

ReceiverPdu - 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: or [0,+infinity) Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.

• Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject

Specified by:

getBboxSize in interface ReceiverPdu

Specified by:

getBboxSize in interface X3DBoundedObject

Returns:

value of bboxSize field

setBboxSize

public ReceiverPdu setBboxSize(float[] newValue)

Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.

Tooltip: or [0,+infinity) Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.

• Hint: can be useful for collision computations or inverse-kinematics (IK) engines.
• Hint: precomputation and inclusion of bounding box information can speed up the initialization of large detailed models, with a corresponding cost of increased file size.
• Hint: X3D Architecture, 10.2.2 Bounding boxes https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#BoundingBoxes
• Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/grouping.html#X3DBoundedObject

Specified by:

setBboxSize in interface ReceiverPdu

Specified by:

setBboxSize in interface X3DBoundedObject

Parameters:

newValue - is new value for the bboxSize field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxSize

public ReceiverPdu setBboxSize(SFVec3f newValue)

Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).

Parameters:

newValue - is new value for the bboxSize field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxSize

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

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxSize

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

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setBboxSize

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

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getDescription

public String getDescription()

Provide String value from inputOutput SFString field named description.

Tooltip: Author-provided prose that describes intended purpose of the node.

• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

getDescription in interface ReceiverPdu

Specified by:

getDescription in interface X3DNetworkSensorNode

Specified by:

getDescription in interface X3DSensorNode

Returns:

value of description field

setDescription

public ReceiverPdu setDescription(String newValue)

Accessor method to assign String value to inputOutput SFString field named description.

Tooltip: Author-provided prose that describes intended purpose of the node.

• Hint: many XML tools substitute XML character references for special characters automatically if needed within an attribute value (such as & for & ampersand character, or " for " quotation-mark character).

Specified by:

setDescription in interface ReceiverPdu

Specified by:

setDescription in interface X3DNetworkSensorNode

Specified by:

setDescription in interface X3DSensorNode

Parameters:

newValue - is new value for the description field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDescription

public ReceiverPdu setDescription(SFString newValue)

Assign typed object value to SFString description field, similar to setDescription(String).

Parameters:

newValue - is new value for the description field.

Returns:

ReceiverPdu - 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 ReceiverPdu setEnabled(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named enabled.

Tooltip: Enables/disables the sensor node. *

Specified by:

setEnabled in interface ReceiverPdu

Specified by:

setEnabled in interface X3DNetworkSensorNode

Specified by:

setEnabled in interface X3DSensorNode

Parameters:

newValue - is new value for the enabled field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setEnabled

public ReceiverPdu setEnabled(SFBool newValue)

Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).

Parameters:

newValue - is new value for the enabled field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getEntityID

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 ReceiverPdu setEntityID(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named entityID.

Tooltip: EntityID unique ID for entity within that application. *

Specified by:

setEntityID in interface ReceiverPdu

Parameters:

newValue - is new value for the entityID field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setEntityID

public ReceiverPdu setEntityID(SFInt32 newValue)

Assign typed object value to SFInt32 entityID field, similar to setEntityID(int).

Parameters:

newValue - is new value for the entityID field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getGeoCoords

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

• Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
• Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>

Specified by:

getGeoCoords in interface ReceiverPdu

Returns:

value of geoCoords field

setGeoCoords

public ReceiverPdu setGeoCoords(double[] newValue)

Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named geoCoords.

Tooltip: Geographic location (specified in current geoSystem coordinates) for children geometry (specified in relative coordinate system, in meters).

• Hint: X3D for Advanced Modeling (X3D4AM) slideset https://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
• Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>

Specified by:

setGeoCoords in interface ReceiverPdu

Parameters:

newValue - is new value for the geoCoords field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setGeoCoords

public ReceiverPdu setGeoCoords(SFVec3d newValue)

Assign typed object value to SFVec3d geoCoords field, similar to setGeoCoords(double[]).

Parameters:

newValue - is new value for the geoCoords field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setGeoCoords

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

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getGeoSystem

public String[] getGeoSystem()

Provide array of String results from initializeOnly MFString field named geoSystem.

Tooltip: Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted string parameters as appropriate for the type.

• Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Spatialreferenceframes
• Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Specifyinggeospatialcoords
• Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
• Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC).

Specified by:

getGeoSystem in interface ReceiverPdu

Returns:

value of geoSystem field

getGeoSystemList

public ArrayList<String> getGeoSystemList()

Utility method to get ArrayList value of MFString geoSystem field, similar to getGeoSystem().

Returns:

value of geoSystem field

getGeoSystemString

public String getGeoSystemString()

Utility method to get String value of MFString geoSystem field, similar to getGeoSystem().

Returns:

value of geoSystem field

setGeoSystem

public ReceiverPdu setGeoSystem(String[] newValue)

Accessor method to assign String array to initializeOnly MFString field named geoSystem.

Tooltip: Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted string parameters as appropriate for the type.

• Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Spatialreferenceframes
• Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/geospatial.html#Specifyinggeospatialcoords
• Hint: UTM is Universal Transverse Mercator coordinate system https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system
• Warning: deprecated values are GDC (replaced by GD) and GCC (replaced by GC).

Specified by:

setGeoSystem in interface ReceiverPdu

Parameters:

newValue - is new value for the geoSystem field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setGeoSystem

public ReceiverPdu setGeoSystem(MFString newValue)

Assign typed object value to MFString geoSystem field, similar to setGeoSystem(String[]).

Parameters:

newValue - is new value for the geoSystem field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setGeoSystem

public ReceiverPdu setGeoSystem(SFString newValue)

Assign single SFString object value to MFString geoSystem field, similar to setGeoSystem(String[]).

Parameters:

newValue - is new value for the geoSystem field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setGeoSystem

public ReceiverPdu setGeoSystem(String newValue)

Assign singleton String value to MFString geoSystem field, similar to setGeoSystem(String[]).

Parameters:

newValue - is new value for the geoSystem field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setGeoSystem

public ReceiverPdu setGeoSystem(ArrayList<String> newValue)

Assign ArrayList value of MFString geoSystem field, similar to setGeoSystem(String[]).

Parameters:

newValue - is new value for the geoSystem field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

clearGeoSystem

public ReceiverPdu clearGeoSystem()

Utility method to clear MFString value of geoSystem field. This method does not initialize with GEOSYSTEM_DEFAULT_VALUE.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addGeoSystem

public ReceiverPdu addGeoSystem(String newValue)

Add singleton String value to MFString geoSystem field, not allowing duplicate or empty string values in this controlled enumeration field.

Parameters:

newValue - is new value to add to the geoSystem field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)
• MFString.hasDuplicateValues()

addGeoSystem

public ReceiverPdu addGeoSystem(SFString newValue)

Add singleton SFString value to MFString geoSystem field, not allowing duplicate or empty string values in this controlled enumeration field.

Parameters:

newValue - is new value to add to the geoSystem field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• MFString.cleanupEnumerationValues(String)
• MFString.hasDuplicateValues()

getIS

public IS getIS()

Provide IS 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 ReceiverPdu setIS(IS newValue)

Accessor method to assign IS 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:

ReceiverPdu - 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 ReceiverPdu clearIS()

Utility method to clear SFNode value of IS field.

Returns:

ReceiverPdu - 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: confirm whether there has been a recent network update.

• Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.

Specified by:

getIsActive in interface 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 org.web3d.x3d.sai.Core.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:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

setMetadata

public ReceiverPdu setMetadata(X3DMetadataObject newValue)

Accessor method to assign org.web3d.x3d.sai.Core.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:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• 
  
  Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.
  • Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4/ISO-IEC19775-1v4-IS/Part01/components/core.html#Metadata
• X3D Scene Authoring Hints: Metadata Nodes

clearMetadata

public ReceiverPdu clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

setMetadata

public ReceiverPdu setMetadata(ProtoInstance 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:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• setMetadata(org.web3d.x3d.sai.Core.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 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 ReceiverPdu setMulticastRelayHost(String newValue)

Accessor method to assign String value to inputOutput SFString field named multicastRelayHost.

Tooltip: Fallback server address if multicast not available locally. For example: track.nps.edu. *

Specified by:

setMulticastRelayHost in interface ReceiverPdu

Parameters:

newValue - is new value for the multicastRelayHost field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setMulticastRelayHost

public ReceiverPdu setMulticastRelayHost(SFString newValue)

Assign typed object value to SFString multicastRelayHost field, similar to setMulticastRelayHost(String).

Parameters:

newValue - is new value for the multicastRelayHost field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getMulticastRelayPort

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 ReceiverPdu setMulticastRelayPort(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named multicastRelayPort.

Tooltip: Fallback server port if multicast not available locally. For example: 8010. *

Specified by:

setMulticastRelayPort in interface ReceiverPdu

Parameters:

newValue - is new value for the multicastRelayPort field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setMulticastRelayPort

public ReceiverPdu setMulticastRelayPort(SFInt32 newValue)

Assign typed object value to SFInt32 multicastRelayPort field, similar to setMulticastRelayPort(int).

Parameters:

newValue - is new value for the multicastRelayPort field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getNetworkMode

public String getNetworkMode()

Provide String enumeration value (baseType xs:NMTOKEN) ["standAlone" | "networkReader" | "networkWriter"] from inputOutput SFString field named networkMode.

Tooltip: Whether this entity is ignoring the network, sending DIS packets to the network, or receiving DIS packets from the network. (1) standAlone: ignore network but still respond to events in local scene. (2) networkReader: listen to network and read PDU packets at readInterval, act as remotely linked copy of entity. (3) networkWriter: send PDU packets to network at writeInterval, act as master entity. Default value "standAlone" ensures that DIS network activation within a scene as networkReader or networkWriter is intentional.

• Warning: do not wrap extra quotation marks around these SFString enumeration values, since "quotation" "marks" are only used for MFString values.
• Warning: network activity may have associated security issues.

Available enumeration values for string comparison: STANDALONE, NETWORKREADER, NETWORKWRITER.

Specified by:

getNetworkMode in interface ReceiverPdu

Returns:

value of networkMode field

setNetworkMode

public ReceiverPdu setNetworkMode(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:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setNetworkMode

public ReceiverPdu setNetworkMode(SFString newValue)

Assign typed object value to SFString networkMode field, similar to setNetworkMode(String).

Parameters:

newValue - is new value for the networkMode field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getPort

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

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setPort

public ReceiverPdu setPort(SFInt32 newValue)

Assign typed object value to SFInt32 port field, similar to setPort(int).

Parameters:

newValue - is new value for the port field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getRadioID

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 ReceiverPdu setRadioID(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named radioID.

Tooltip: Identifies a particular radio within a given entity. *

Specified by:

setRadioID in interface ReceiverPdu

Parameters:

newValue - is new value for the radioID field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setRadioID

public ReceiverPdu setRadioID(SFInt32 newValue)

Assign typed object value to SFInt32 radioID field, similar to setRadioID(int).

Parameters:

newValue - is new value for the radioID field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getReadInterval

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 ReceiverPdu setReadInterval(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named readInterval.

Tooltip: [0,+infinity) Seconds between read updates, 0 means no reading.

• Hint: readInterval is a nonnegative SFTime duration interval, not an absolute clock time.

Specified by:

setReadInterval in interface ReceiverPdu

Parameters:

newValue - is new value for the readInterval field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setReadInterval

public ReceiverPdu setReadInterval(SFTime newValue)

Assign typed object value to SFTime readInterval field, similar to setReadInterval(double).

Parameters:

newValue - is new value for the readInterval field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getReceivedPower

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 ReceiverPdu setReceivedPower(float newValue)

Accessor method to assign float value to inputOutput SFFloat field named receivedPower.

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

Specified by:

setReceivedPower in interface ReceiverPdu

Parameters:

newValue - is new value for the receivedPower field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setReceivedPower

public ReceiverPdu setReceivedPower(SFFloat newValue)

Assign typed object value to SFFloat receivedPower field, similar to setReceivedPower(float).

Parameters:

newValue - is new value for the receivedPower field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setReceivedPower

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

ReceiverPdu - 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 ReceiverPdu setReceiverState(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named receiverState.

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

Specified by:

setReceiverState in interface ReceiverPdu

Parameters:

newValue - is new value for the receiverState field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setReceiverState

public ReceiverPdu setReceiverState(SFInt32 newValue)

Assign typed object value to SFInt32 receiverState field, similar to setReceiverState(int).

Parameters:

newValue - is new value for the receiverState field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getRtpHeaderExpected

public boolean getRtpHeaderExpected()

Provide boolean value from inputOutput 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 ReceiverPdu setRtpHeaderExpected(boolean newValue)

Accessor method to assign boolean value to inputOutput 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:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setRtpHeaderExpected

public ReceiverPdu setRtpHeaderExpected(SFBool newValue)

Assign typed object value to SFBool rtpHeaderExpected field, similar to setRtpHeaderExpected(boolean).

Parameters:

newValue - is new value for the rtpHeaderExpected field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getSiteID

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 ReceiverPdu setSiteID(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named siteID.

Tooltip: Simulation/exercise siteID of the participating LAN or organization. *

Specified by:

setSiteID in interface ReceiverPdu

Parameters:

newValue - is new value for the siteID field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setSiteID

public ReceiverPdu setSiteID(SFInt32 newValue)

Assign typed object value to SFInt32 siteID field, similar to setSiteID(int).

Parameters:

newValue - is new value for the siteID field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getTimestamp

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 ReceiverPdu setTransmitterApplicationID(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named transmitterApplicationID.

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

Specified by:

setTransmitterApplicationID in interface ReceiverPdu

Parameters:

newValue - is new value for the transmitterApplicationID field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setTransmitterApplicationID

public ReceiverPdu setTransmitterApplicationID(SFInt32 newValue)

Assign typed object value to SFInt32 transmitterApplicationID field, similar to setTransmitterApplicationID(int).

Parameters:

newValue - is new value for the transmitterApplicationID field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getTransmitterEntityID

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 ReceiverPdu setTransmitterEntityID(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named transmitterEntityID.

Tooltip: Simulation/exercise transmitterEntityID is a unique ID for a single entity within that application. *

Specified by:

setTransmitterEntityID in interface ReceiverPdu

Parameters:

newValue - is new value for the transmitterEntityID field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setTransmitterEntityID

public ReceiverPdu setTransmitterEntityID(SFInt32 newValue)

Assign typed object value to SFInt32 transmitterEntityID field, similar to setTransmitterEntityID(int).

Parameters:

newValue - is new value for the transmitterEntityID field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getTransmitterRadioID

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 ReceiverPdu setTransmitterRadioID(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named transmitterRadioID.

Tooltip: Identifies a particular radio within a given entity. *

Specified by:

setTransmitterRadioID in interface ReceiverPdu

Parameters:

newValue - is new value for the transmitterRadioID field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setTransmitterRadioID

public ReceiverPdu setTransmitterRadioID(SFInt32 newValue)

Assign typed object value to SFInt32 transmitterRadioID field, similar to setTransmitterRadioID(int).

Parameters:

newValue - is new value for the transmitterRadioID field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getTransmitterSiteID

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 ReceiverPdu setTransmitterSiteID(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named transmitterSiteID.

Tooltip: Simulation/exercise transmitterSiteID of the participating LAN or organization. *

Specified by:

setTransmitterSiteID in interface ReceiverPdu

Parameters:

newValue - is new value for the transmitterSiteID field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setTransmitterSiteID

public ReceiverPdu setTransmitterSiteID(SFInt32 newValue)

Assign typed object value to SFInt32 transmitterSiteID field, similar to setTransmitterSiteID(int).

Parameters:

newValue - is new value for the transmitterSiteID field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getVisible

public boolean getVisible()

Provide boolean value from inputOutput SFBool field named visible.

Tooltip: Whether or not renderable content within this node is visually displayed.

• Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
• Hint: content must be visible to be collidable and to be pickable.

Specified by:

getVisible in interface ReceiverPdu

Specified by:

getVisible in interface X3DBoundedObject

Returns:

value of visible field

setVisible

public ReceiverPdu setVisible(boolean newValue)

Accessor method to assign boolean value to inputOutput SFBool field named visible.

Tooltip: Whether or not renderable content within this node is visually displayed.

• Hint: the visible field has no effect on animation behaviors, event passing or other non-visual characteristics.
• Hint: content must be visible to be collidable and to be pickable.

Specified by:

setVisible in interface ReceiverPdu

Specified by:

setVisible in interface X3DBoundedObject

Parameters:

newValue - is new value for the visible field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setVisible

public ReceiverPdu setVisible(SFBool newValue)

Assign typed object value to SFBool visible field, similar to setVisible(boolean).

Parameters:

newValue - is new value for the visible field.

Returns:

ReceiverPdu - 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 ReceiverPdu setWhichGeometry(int newValue)

Accessor method to assign int value to inputOutput SFInt32 field named whichGeometry.

Tooltip: Select geometry to render: -1 for no geometry, 0 for text trace, 1 for default geometry, (optional) higher values to render different states. *

Specified by:

setWhichGeometry in interface ReceiverPdu

Parameters:

newValue - is new value for the whichGeometry field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setWhichGeometry

public ReceiverPdu setWhichGeometry(SFInt32 newValue)

Assign typed object value to SFInt32 whichGeometry field, similar to setWhichGeometry(int).

Parameters:

newValue - is new value for the whichGeometry field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getWriteInterval

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 ReceiverPdu setWriteInterval(double newValue)

Accessor method to assign double value in seconds to inputOutput SFTime field named writeInterval.

Tooltip: [0,+infinity) Seconds between write updates, 0 means no writing (sending).

• Hint: writeInterval is a nonnegative SFTime duration interval, not an absolute clock time.

Specified by:

setWriteInterval in interface ReceiverPdu

Parameters:

newValue - is new value for the writeInterval field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setWriteInterval

public ReceiverPdu setWriteInterval(SFTime newValue)

Assign typed object value to SFTime writeInterval field, similar to setWriteInterval(double).

Parameters:

newValue - is new value for the writeInterval field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getDEF

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

• Hint: descriptive DEF names improve clarity and help document a model.
• Hint: well-defined names can simplify design and debugging through improved author understanding.
• Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

Overrides:

getDEF in class X3DConcreteNode

Returns:

value of DEF field

See Also:

• X3D Scene Authoring Hints: Naming Conventions

setDEF

public final ReceiverPdu setDEF(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.

• Hint: descriptive DEF names improve clarity and help document a model.
• Hint: well-defined names can simplify design and debugging through improved author understanding.
• Hint: X3D Scene Authoring Hints, Naming Conventions https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#NamingConventions

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:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setDEF

public ReceiverPdu setDEF(SFString newValue)

Assign typed object value to SFString DEF field, similar to setDEF(String).

Parameters:

newValue - is new value for the DEF field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getUSE

public 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 ReceiverPdu setUSE(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:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public ReceiverPdu setUSE(SFString newValue)

Assign typed object value to SFString USE field, similar to setUSE(String).

Parameters:

newValue - is new value for the USE field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssClass

public String getCssClass()

Provide String value from inputOutput SFString field named class.

Overrides:

getCssClass in class X3DConcreteElement

Returns:

value of class field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public final ReceiverPdu setCssClass(String newValue)

Accessor method to assign String value to inputOutput SFString field named class.

Specified by:

setCssClass in class X3DConcreteNode

Parameters:

newValue - is new value for the class field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

public ReceiverPdu setCssClass(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssClass(String).

Parameters:

newValue - is new value for the class field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getHtmlId

public String getHtmlId()

Provide String value from inputOutput SFString field named id.

Overrides:

getHtmlId in class X3DConcreteElement

Returns:

value of id field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlId

public final ReceiverPdu setHtmlId(String newValue)

Accessor method to assign String value to inputOutput SFString field named id.

Specified by:

setHtmlId in class X3DConcreteNode

Parameters:

newValue - is new value for the id field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
  Warning: the id attribute is in a distinct separate namespace from DEF identifiers and thus not applicable for USE nodes, ROUTE statements, or Script references.
• X3D Architecture Annex L - HTML authoring guidelines, L.3.1 Content definition and page presentation
• HTML 5.2 W3C Recommendation
• Document Object Model (DOM) Technical Reports
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlId

public ReceiverPdu setHtmlId(SFString newValue)

Assign typed object value to SFString HtmlId field, similar to setHtmlId(String).

Parameters:

newValue - is new value for the id field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

getCssStyle

public String getCssStyle()

Provide String value from inputOutput SFString field named style.

Overrides:

getCssStyle in class X3DConcreteElement

Returns:

value of style field

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public final ReceiverPdu setCssStyle(String newValue)

Accessor method to assign String value to inputOutput SFString field named style.

Specified by:

setCssStyle in class X3DConcreteNode

Parameters:

newValue - is new value for the style field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture Annex L - HTML authoring guidelines, CSS considerations
• W3C Cascading Style Sheets
• W3C CSS tutorial: Starting with HTML + CSS
• W3C CSS Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

public ReceiverPdu setCssStyle(SFString newValue)

Assign typed object value to SFString cssClass field, similar to setCssStyle(String).

Parameters:

newValue - is new value for the style field.

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

setUSE

public ReceiverPdu setUSE(ReceiverPdu 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:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

addComments

public ReceiverPdu addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).

See Also:

• X3D Architecture, clause 7.2.5.1 Organization

addComments

public ReceiverPdu addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

addComments

public ReceiverPdu addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

ReceiverPdu - namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).

toStringX3D

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

• X3D.FILE_EXTENSION_X3D
• X3D.FILE_EXTENSION_XML
• X3D.toStringXML()
• X3D.toFileXML(String)
• X3D.toFileX3D(String)
• X3D XML Encoding
• X3D Compressed Binary Encoding: X3D Canonical Form
• X3D Canonicalization (C14N) Tool

toStringClassicVRML

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

• X3D.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 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:

• X3D.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(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

findElementByNameValue

public X3DConcreteElement findElementByNameValue(String nameValue,
 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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasElementByNameValue

public boolean hasElementByNameValue(String nameValue,
 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(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 findAncestorScene() to check entire scene graph, or findAncestorX3D() 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.hasAncestorScene()
• X3DConcreteElement.findAncestorX3D()

hasNodeByDEF

public boolean hasNodeByDEF(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 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. TODO document specific validation methods.

Specified by:

validate in class X3DConcreteElement

Returns:

validation results (if any)