Package org.web3d.x3d.jsail.DIS

Class SignalPdu

java.lang.Object

org.web3d.x3d.jsail.X3DConcreteElement

org.web3d.x3d.jsail.X3DConcreteNode

org.web3d.x3d.jsail.DIS.SignalPdu

All Implemented Interfaces:

X3DChildNode, X3DNode, X3DSensorNode, SignalPdu, X3DBoundedObject, X3DNetworkSensorNode

public class SignalPdu
extends X3DConcreteNode
implements SignalPdu

SignalPdu is a networked Protocol Data Unit (PDU) information node that communicates the transmission of voice, audio or other data modeled in a simulation.

Warning: this is an abstract interface that cannot be instantiated as a concrete object. Java programmers typically only need to use concrete objects provided by the org.web3d.x3d.jsail classes. SignalPdu node tooltip: [X3DNetworkSensorNode,X3DBoundedObject,X3DVisibleObject] SignalPdu is a networked Protocol Data Unit (PDU) information node that communicates the transmission of voice, audio or other data modeled in a simulation.

• Hint: SignalPdu 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: SignalPdu
• X3D Tooltips: SignalPdu
• 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 SignalPdu element: DIS
static final String	containerField_DEFAULT_VALUE	containerField describes typical field relationship of a node to its parent.
static final ArrayList<Integer>	DATA_DEFAULT_VALUE	MFInt32 field named data has default value equal to an empty list.
static final int	DATALENGTH_DEFAULT_VALUE	SFInt32 field named dataLength has default value 0 (Java syntax) or 0 (XML syntax).
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	ENCODINGSCHEME_DEFAULT_VALUE	SFInt32 field named encodingScheme has default value 0 (Java syntax) or 0 (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_DATA	fromField ROUTE name for MFInt32 field named data.
static final String	fromField_DATALENGTH	fromField ROUTE name for SFInt32 field named dataLength.
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_ENCODINGSCHEME	fromField ROUTE name for SFInt32 field named encodingScheme.
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_RTPHEADEREXPECTED	fromField ROUTE name for SFBool field named rtpHeaderExpected.
static final String	fromField_SAMPLERATE	fromField ROUTE name for SFInt32 field named sampleRate.
static final String	fromField_SAMPLES	fromField ROUTE name for SFInt32 field named samples.
static final String	fromField_SITEID	fromField ROUTE name for SFInt32 field named siteID.
static final String	fromField_TDLTYPE	fromField ROUTE name for SFInt32 field named tdlType.
static final String	fromField_TIMESTAMP	fromField ROUTE name for SFTime field named timestamp.
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 ArrayList<String>	GEOSYSTEM_DEFAULT_VALUE	MFString field named geoSystem has default quoted value new String[] {"GD","WE"} (Java syntax) or quoted value "GD" "WE" (XML syntax).
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: SignalPdu.
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 boolean	RTPHEADEREXPECTED_DEFAULT_VALUE	SFBool field named rtpHeaderExpected has default value false (Java syntax) or false (XML syntax).
static final int	SAMPLERATE_DEFAULT_VALUE	SFInt32 field named sampleRate has default value 0 (Java syntax) or 0 (XML syntax).
static final int	SAMPLES_DEFAULT_VALUE	SFInt32 field named samples has default value 0 (Java syntax) or 0 (XML syntax).
static final int	SITEID_DEFAULT_VALUE	SFInt32 field named siteID has default value 0 (Java syntax) or 0 (XML syntax).
static final int	TDLTYPE_DEFAULT_VALUE	SFInt32 field named tdlType 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_DATA	toField ROUTE name for MFInt32 field named data.
static final String	toField_DATALENGTH	toField ROUTE name for SFInt32 field named dataLength.
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_ENCODINGSCHEME	toField ROUTE name for SFInt32 field named encodingScheme.
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_RTPHEADEREXPECTED	toField ROUTE name for SFBool field named rtpHeaderExpected.
static final String	toField_SAMPLERATE	toField ROUTE name for SFInt32 field named sampleRate.
static final String	toField_SAMPLES	toField ROUTE name for SFInt32 field named samples.
static final String	toField_SITEID	toField ROUTE name for SFInt32 field named siteID.
static final String	toField_TDLTYPE	toField ROUTE name for SFInt32 field named tdlType.
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 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, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE

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

CLASS_DEFAULT_VALUE, ID_DEFAULT_VALUE, STYLE_DEFAULT_VALUE, validationResult

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SignalPdu	addComments(String newComment)	Add comment as String to contained commentsList.
SignalPdu	addComments(String[] newComments)	Add comments as String[] array to contained commentsList.
SignalPdu	addComments(CommentsBlock newCommentsBlock)	Add CommentsBlock to contained commentsList.
SignalPdu	addData(int newValue)	Add singleton int value to MFInt32 data field.
SignalPdu	addData(SFInt32 newValue)	Add singleton SFInt32 value to MFInt32 data field.
SignalPdu	addGeoSystem(String newValue)	Add singleton String value to MFString geoSystem field.
SignalPdu	addGeoSystem(SFString newValue)	Add singleton SFString value to MFString geoSystem field.
SignalPdu	clearData()	Utility method to clear MFInt32 value of data field.
SignalPdu	clearGeoSystem()	Utility method to clear MFString value of geoSystem field.
SignalPdu	clearIS()	Utility method to clear SFNode value of IS field.
SignalPdu	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.
int	getApplicationID()	Provide int value from inputOutput SFInt32 field named applicationID.
float[]	getBboxCenter()	Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
boolean	getBboxDisplay()	Provide boolean value from inputOutput SFBool field named bboxDisplay.
float[]	getBboxSize()	Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
final String	getComponent()	Defines X3D component for the SignalPdu 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.
int[]	getData()	Provide array of Integer results from inputOutput MFInt32 field named data.
int	getDataLength()	Provide int value from inputOutput SFInt32 field named dataLength.
ArrayList<Integer>	getDataList()	Utility method to get ArrayList value of MFInt32 data field, similar to getData().
String	getDataString()	Utility method to get String value of MFInt32 data field, similar to getData().
String	getDEF()	Provide String value from inputOutput SFString field named DEF.
String	getDescription()	Provide String value from inputOutput SFString field named description.
final String	getElementName()	Provides name of this element: SignalPdu
boolean	getEnabled()	Provide boolean value from inputOutput SFBool field named enabled.
int	getEncodingScheme()	Provide int value from inputOutput SFInt32 field named encodingScheme.
int	getEntityID()	Provide int value from inputOutput SFInt32 field named entityID.
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.
String[]	getGeoSystem()	Provide array of String results from initializeOnly MFString field named geoSystem.
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.
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.
String	getMulticastRelayHost()	Provide String value from inputOutput SFString field named multicastRelayHost.
int	getMulticastRelayPort()	Provide int value from inputOutput SFInt32 field named multicastRelayPort.
String	getNetworkMode()	Provide String enumeration value (baseType xs:NMTOKEN) ["standAlone" | "networkReader" | "networkWriter"] from inputOutput SFString field named networkMode.
int	getPort()	Provide int value from inputOutput SFInt32 field named port.
int	getRadioID()	Provide int value from inputOutput SFInt32 field named radioID.
double	getReadInterval()	Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named readInterval.
boolean	getRtpHeaderExpected()	Provide boolean value from inputOutput SFBool field named rtpHeaderExpected.
int	getSampleRate()	Provide int value from inputOutput SFInt32 field named sampleRate.
int	getSamples()	Provide int value from inputOutput SFInt32 field named samples.
int	getSiteID()	Provide int value from inputOutput SFInt32 field named siteID.
int	getTdlType()	Provide int value from inputOutput SFInt32 field named tdlType.
double	getTimestamp()	Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named timestamp.
String	getUSE()	Provide String value from inputOutput SFString field named USE.
boolean	getVisible()	Provide boolean value from inputOutput SFBool field named visible.
int	getWhichGeometry()	Provide int value from inputOutput SFInt32 field named whichGeometry.
double	getWriteInterval()	Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named writeInterval.
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.
SignalPdu	setAddress(String newValue)	Accessor method to assign String value to inputOutput SFString field named address.
SignalPdu	setAddress(SFString newValue)	Assign typed object value to SFString address field, similar to setAddress(String).
SignalPdu	setApplicationID(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named applicationID.
SignalPdu	setApplicationID(SFInt32 newValue)	Assign typed object value to SFInt32 applicationID field, similar to setApplicationID(int).
SignalPdu	setBboxCenter(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxCenter(float[]).
SignalPdu	setBboxCenter(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxCenter(float[]).
SignalPdu	setBboxCenter(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.
SignalPdu	setBboxCenter(float x, float y, float z)	Assign values to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
SignalPdu	setBboxCenter(SFVec3f newValue)	Assign typed object value to SFVec3f bboxCenter field, similar to setBboxCenter(float[]).
SignalPdu	setBboxDisplay(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.
SignalPdu	setBboxDisplay(SFBool newValue)	Assign typed object value to SFBool bboxDisplay field, similar to setBboxDisplay(boolean).
SignalPdu	setBboxSize(double[] newArray)	Utility method: double-precision set-array accessor for X3D floating-point type, similar to setBboxSize(float[]).
SignalPdu	setBboxSize(double x, double y, double z)	Utility method: double-precision set-parameters accessor for X3D floating-point type, similar to setBboxSize(float[]).
SignalPdu	setBboxSize(float[] newValue)	Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
SignalPdu	setBboxSize(float x, float y, float z)	Assign values to SFVec3f bboxSize field, similar to setBboxSize(float[]).
SignalPdu	setBboxSize(SFVec3f newValue)	Assign typed object value to SFVec3f bboxSize field, similar to setBboxSize(float[]).
final SignalPdu	setCssClass(String newValue)	Accessor method to assign String value to inputOutput SFString field named class.
SignalPdu	setCssClass(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssClass(String).
final SignalPdu	setCssStyle(String newValue)	Accessor method to assign String value to inputOutput SFString field named style.
SignalPdu	setCssStyle(SFString newValue)	Assign typed object value to SFString cssClass field, similar to setCssStyle(String).
SignalPdu	setData(int[] newValue)	Accessor method to assign Integer array to inputOutput MFInt32 field named data.
SignalPdu	setData(ArrayList<Integer> newValue)	Assign ArrayList value of MFInt32 data field, similar to setData(int[]).
SignalPdu	setData(MFInt32 newValue)	Assign typed object value to MFInt32 data field, similar to setData(int[]).
SignalPdu	setDataLength(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named dataLength.
SignalPdu	setDataLength(SFInt32 newValue)	Assign typed object value to SFInt32 dataLength field, similar to setDataLength(int).
final SignalPdu	setDEF(String newValue)	Accessor method to assign String value to inputOutput SFString field named DEF.
SignalPdu	setDEF(SFString newValue)	Assign typed object value to SFString DEF field, similar to setDEF(String).
SignalPdu	setDescription(String newValue)	Accessor method to assign String value to inputOutput SFString field named description.
SignalPdu	setDescription(SFString newValue)	Assign typed object value to SFString description field, similar to setDescription(String).
SignalPdu	setEnabled(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named enabled.
SignalPdu	setEnabled(SFBool newValue)	Assign typed object value to SFBool enabled field, similar to setEnabled(boolean).
SignalPdu	setEncodingScheme(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named encodingScheme.
SignalPdu	setEncodingScheme(SFInt32 newValue)	Assign typed object value to SFInt32 encodingScheme field, similar to setEncodingScheme(int).
SignalPdu	setEntityID(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named entityID.
SignalPdu	setEntityID(SFInt32 newValue)	Assign typed object value to SFInt32 entityID field, similar to setEntityID(int).
SignalPdu	setGeoCoords(double[] newValue)	Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named geoCoords.
SignalPdu	setGeoCoords(double x, double y, double z)	Assign values to SFVec3d geoCoords field, similar to setGeoCoords(double[]).
SignalPdu	setGeoCoords(SFVec3d newValue)	Assign typed object value to SFVec3d geoCoords field, similar to setGeoCoords(double[]).
SignalPdu	setGeoSystem(String newValue)	Assign singleton String value to MFString geoSystem field, similar to setGeoSystem(String[]).
SignalPdu	setGeoSystem(String[] newValue)	Accessor method to assign String array to initializeOnly MFString field named geoSystem.
SignalPdu	setGeoSystem(ArrayList<String> newValue)	Assign ArrayList value of MFString geoSystem field, similar to setGeoSystem(String[]).
SignalPdu	setGeoSystem(MFString newValue)	Assign typed object value to MFString geoSystem field, similar to setGeoSystem(String[]).
SignalPdu	setGeoSystem(SFString newValue)	Assign single SFString object value to MFString geoSystem field, similar to setGeoSystem(String[]).
final SignalPdu	setHtmlID(String newValue)	Accessor method to assign String value to inputOutput SFString field named id.
SignalPdu	setHtmlID(SFString newValue)	Assign typed object value to SFString HtmlID field, similar to setHtmlID(String).
SignalPdu	setIS(IS newValue)	Accessor method to assign IS instance (using a properly typed node) to inputOutput SFNode field IS.
SignalPdu	setMetadata(ProtoInstance newValue)	Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.
SignalPdu	setMetadata(X3DMetadataObject newValue)	Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
SignalPdu	setMulticastRelayHost(String newValue)	Accessor method to assign String value to inputOutput SFString field named multicastRelayHost.
SignalPdu	setMulticastRelayHost(SFString newValue)	Assign typed object value to SFString multicastRelayHost field, similar to setMulticastRelayHost(String).
SignalPdu	setMulticastRelayPort(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named multicastRelayPort.
SignalPdu	setMulticastRelayPort(SFInt32 newValue)	Assign typed object value to SFInt32 multicastRelayPort field, similar to setMulticastRelayPort(int).
SignalPdu	setNetworkMode(String newValue)	Accessor method to assign String enumeration value ("standAlone" | "networkReader" | "networkWriter") to inputOutput SFString field named networkMode.
SignalPdu	setNetworkMode(SFString newValue)	Assign typed object value to SFString networkMode field, similar to setNetworkMode(String).
SignalPdu	setPort(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named port.
SignalPdu	setPort(SFInt32 newValue)	Assign typed object value to SFInt32 port field, similar to setPort(int).
SignalPdu	setRadioID(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named radioID.
SignalPdu	setRadioID(SFInt32 newValue)	Assign typed object value to SFInt32 radioID field, similar to setRadioID(int).
SignalPdu	setReadInterval(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named readInterval.
SignalPdu	setReadInterval(SFTime newValue)	Assign typed object value to SFTime readInterval field, similar to setReadInterval(double).
SignalPdu	setRtpHeaderExpected(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named rtpHeaderExpected.
SignalPdu	setRtpHeaderExpected(SFBool newValue)	Assign typed object value to SFBool rtpHeaderExpected field, similar to setRtpHeaderExpected(boolean).
SignalPdu	setSampleRate(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named sampleRate.
SignalPdu	setSampleRate(SFInt32 newValue)	Assign typed object value to SFInt32 sampleRate field, similar to setSampleRate(int).
SignalPdu	setSamples(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named samples.
SignalPdu	setSamples(SFInt32 newValue)	Assign typed object value to SFInt32 samples field, similar to setSamples(int).
SignalPdu	setSiteID(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named siteID.
SignalPdu	setSiteID(SFInt32 newValue)	Assign typed object value to SFInt32 siteID field, similar to setSiteID(int).
SignalPdu	setTdlType(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named tdlType.
SignalPdu	setTdlType(SFInt32 newValue)	Assign typed object value to SFInt32 tdlType field, similar to setTdlType(int).
final SignalPdu	setUSE(String newValue)	Accessor method to assign String value to inputOutput SFString field named USE.
SignalPdu	setUSE(SignalPdu DEFnode)	Assign a USE reference to another DEF node of same node type, similar to setUSE(String).
SignalPdu	setUSE(SFString newValue)	Assign typed object value to SFString USE field, similar to setUSE(String).
SignalPdu	setVisible(boolean newValue)	Accessor method to assign boolean value to inputOutput SFBool field named visible.
SignalPdu	setVisible(SFBool newValue)	Assign typed object value to SFBool visible field, similar to setVisible(boolean).
SignalPdu	setWhichGeometry(int newValue)	Accessor method to assign int value to inputOutput SFInt32 field named whichGeometry.
SignalPdu	setWhichGeometry(SFInt32 newValue)	Assign typed object value to SFInt32 whichGeometry field, similar to setWhichGeometry(int).
SignalPdu	setWriteInterval(double newValue)	Accessor method to assign double value in seconds to inputOutput SFTime field named writeInterval.
SignalPdu	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, getName, 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, 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: SignalPdu.

See Also:

• Constant Field Values

COMPONENT

public static final String COMPONENT

String constant COMPONENT defines X3D component for the SignalPdu 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).

DATA_DEFAULT_VALUE

public static final ArrayList<Integer> DATA_DEFAULT_VALUE

MFInt32 field named data has default value equal to an empty list.

DATALENGTH_DEFAULT_VALUE

public static final int DATALENGTH_DEFAULT_VALUE

SFInt32 field named dataLength has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

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

ENCODINGSCHEME_DEFAULT_VALUE

public static final int ENCODINGSCHEME_DEFAULT_VALUE

SFInt32 field named encodingScheme has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

ENTITYID_DEFAULT_VALUE

public static final int ENTITYID_DEFAULT_VALUE

SFInt32 field named entityID has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

GEOCOORDS_DEFAULT_VALUE

public static final double[] GEOCOORDS_DEFAULT_VALUE

SFVec3d field named geoCoords has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax).

GEOSYSTEM_DEFAULT_VALUE

public static final ArrayList<String> GEOSYSTEM_DEFAULT_VALUE

MFString field named geoSystem has default quoted value new String[] {"GD","WE"} (Java syntax) or quoted value "GD" "WE" (XML syntax).

IS_DEFAULT_VALUE

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

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

SAMPLERATE_DEFAULT_VALUE

public static final int SAMPLERATE_DEFAULT_VALUE

SFInt32 field named sampleRate has default value 0 (Java syntax) or 0 (XML syntax).

See Also:

• Constant Field Values

SAMPLES_DEFAULT_VALUE

public static final int SAMPLES_DEFAULT_VALUE

SFInt32 field named samples has default value 0 (Java syntax) or 0 (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

TDLTYPE_DEFAULT_VALUE

public static final int TDLTYPE_DEFAULT_VALUE

SFInt32 field named tdlType 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:

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

public static final String fromField_DATA

fromField ROUTE name for MFInt32 field named data.

See Also:

• Constant Field Values

toField_DATA

public static final String toField_DATA

toField ROUTE name for MFInt32 field named data.

See Also:

• Constant Field Values

fromField_DATALENGTH

public static final String fromField_DATALENGTH

fromField ROUTE name for SFInt32 field named dataLength.

See Also:

• Constant Field Values

toField_DATALENGTH

public static final String toField_DATALENGTH

toField ROUTE name for SFInt32 field named dataLength.

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_ENCODINGSCHEME

public static final String fromField_ENCODINGSCHEME

fromField ROUTE name for SFInt32 field named encodingScheme.

See Also:

• Constant Field Values

toField_ENCODINGSCHEME

public static final String toField_ENCODINGSCHEME

toField ROUTE name for SFInt32 field named encodingScheme.

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_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_SAMPLERATE

public static final String fromField_SAMPLERATE

fromField ROUTE name for SFInt32 field named sampleRate.

See Also:

• Constant Field Values

toField_SAMPLERATE

public static final String toField_SAMPLERATE

toField ROUTE name for SFInt32 field named sampleRate.

See Also:

• Constant Field Values

fromField_SAMPLES

public static final String fromField_SAMPLES

fromField ROUTE name for SFInt32 field named samples.

See Also:

• Constant Field Values

toField_SAMPLES

public static final String toField_SAMPLES

toField ROUTE name for SFInt32 field named samples.

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_TDLTYPE

public static final String fromField_TDLTYPE

fromField ROUTE name for SFInt32 field named tdlType.

See Also:

• Constant Field Values

toField_TDLTYPE

public static final String toField_TDLTYPE

toField ROUTE name for SFInt32 field named tdlType.

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_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

SignalPdu

public SignalPdu()

Constructor for SignalPdu to initialize member variables with default values.

SignalPdu

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

Specified by:

getElementName in class X3DConcreteElement

Returns:

name of this element

getComponent

public final String getComponent()

Defines X3D component for the SignalPdu element: DIS

Specified by:

getComponent in class X3DConcreteElement

Returns:

X3D component for this element

getComponentLevel

public final int getComponentLevel()

Provides default X3D component level for this element: 1

Specified by:

getComponentLevel in class X3DConcreteElement

Returns:

default X3D component level for this element

getFieldType

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

Returns:

value of address field

setAddress

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

Parameters:

newValue - is new value for the address field.

Returns:

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

setAddress

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

SignalPdu - 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 SignalPdu

Returns:

value of applicationID field

setApplicationID

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

Parameters:

newValue - is new value for the applicationID field.

Returns:

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

setApplicationID

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

SignalPdu - 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 SignalPdu

Specified by:

getBboxCenter in interface X3DBoundedObject

Returns:

value of bboxCenter field

setBboxCenter

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

Specified by:

setBboxCenter in interface X3DBoundedObject

Parameters:

newValue - is new value for the bboxCenter field.

Returns:

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

setBboxCenter

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

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

setBboxCenter

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

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

setBboxCenter

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

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

setBboxCenter

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

SignalPdu - 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 SignalPdu

Specified by:

getBboxDisplay in interface X3DBoundedObject

Returns:

value of bboxDisplay field

setBboxDisplay

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

Specified by:

setBboxDisplay in interface X3DBoundedObject

Parameters:

newValue - is new value for the bboxDisplay field.

Returns:

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

setBboxDisplay

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

SignalPdu - 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 SignalPdu

Specified by:

getBboxSize in interface X3DBoundedObject

Returns:

value of bboxSize field

setBboxSize

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

Specified by:

setBboxSize in interface X3DBoundedObject

Parameters:

newValue - is new value for the bboxSize field.

Returns:

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

setBboxSize

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

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

setBboxSize

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

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

setBboxSize

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

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

setBboxSize

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

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

getData

public int[] getData()

Provide array of Integer results from inputOutput MFInt32 field named data.

Tooltip: Holds audio or digital data conveyed by the radio transmission. Interpretation of the field depends on values of encodingScheme and tdlType fields. *

Specified by:

getData in interface SignalPdu

Returns:

value of data field

getDataList

public ArrayList<Integer> getDataList()

Utility method to get ArrayList value of MFInt32 data field, similar to getData().

Returns:

value of data field

getDataString

public String getDataString()

Utility method to get String value of MFInt32 data field, similar to getData().

Returns:

value of data field

setData

public SignalPdu setData(int[] newValue)

Accessor method to assign Integer array to inputOutput MFInt32 field named data.

Tooltip: Holds audio or digital data conveyed by the radio transmission. Interpretation of the field depends on values of encodingScheme and tdlType fields. *

Specified by:

setData in interface SignalPdu

Parameters:

newValue - is new value for the data field.

Returns:

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

setData

public SignalPdu setData(MFInt32 newValue)

Assign typed object value to MFInt32 data field, similar to setData(int[]).

Parameters:

newValue - is new value for the data field.

Returns:

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

setData

public SignalPdu setData(ArrayList<Integer> newValue)

Assign ArrayList value of MFInt32 data field, similar to setData(int[]).

Parameters:

newValue - is new value for the data field.

Returns:

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

clearData

public SignalPdu clearData()

Utility method to clear MFInt32 value of data field. This method does not initialize withDATA_DEFAULT_VALUE.

Returns:

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

addData

public SignalPdu addData(int newValue)

Add singleton int value to MFInt32 data field.

Parameters:

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

Returns:

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

addData

public SignalPdu addData(SFInt32 newValue)

Add singleton SFInt32 value to MFInt32 data field.

Parameters:

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

Returns:

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

getDataLength

public int getDataLength()

Provide int value from inputOutput SFInt32 field named dataLength.

Tooltip: number of bits of digital voice audio or digital data being sent in the Signal PDU. If the Encoding Class is database index, then dataLength field is set to 96. *

Specified by:

getDataLength in interface SignalPdu

Returns:

value of dataLength field

setDataLength

public SignalPdu setDataLength(int newValue)

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

Tooltip: number of bits of digital voice audio or digital data being sent in the Signal PDU. If the Encoding Class is database index, then dataLength field is set to 96. *

Specified by:

setDataLength in interface SignalPdu

Parameters:

newValue - is new value for the dataLength field.

Returns:

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

setDataLength

public SignalPdu setDataLength(SFInt32 newValue)

Assign typed object value to SFInt32 dataLength field, similar to setDataLength(int).

Parameters:

newValue - is new value for the dataLength field.

Returns:

SignalPdu - 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 SignalPdu

Specified by:

getDescription in interface X3DNetworkSensorNode

Specified by:

getDescription in interface X3DSensorNode

Returns:

value of description field

setDescription

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

Specified by:

setDescription in interface X3DNetworkSensorNode

Specified by:

setDescription in interface X3DSensorNode

Parameters:

newValue - is new value for the description field.

Returns:

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

setDescription

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

SignalPdu - 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 SignalPdu

Specified by:

getEnabled in interface X3DNetworkSensorNode

Specified by:

getEnabled in interface X3DSensorNode

Returns:

value of enabled field

setEnabled

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

Specified by:

setEnabled in interface X3DNetworkSensorNode

Specified by:

setEnabled in interface X3DSensorNode

Parameters:

newValue - is new value for the enabled field.

Returns:

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

setEnabled

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

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

getEncodingScheme

public int getEncodingScheme()

Provide int value from inputOutput SFInt32 field named encodingScheme.

Tooltip: designates both Encoding Class and Encoding Type. Encoding Class enumerated value (2 most significant bits): 0 = Encoded Voice; 1 = Raw Binary Data; 2 = Application-Specific Data; 3 = Database Index. Encoding Type enumerated value (14 least significant bits): 1 = 8-bit mu-law; 2 = CVSD per MIL-STD-188-113; 3 = ADPCM per CCITT G.721; 4 = 16-bit linear PCM; 5 = 8-bit linear PCM; 6 = Vector Quantization. *

Specified by:

getEncodingScheme in interface SignalPdu

Returns:

value of encodingScheme field

setEncodingScheme

public SignalPdu setEncodingScheme(int newValue)

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

Tooltip: designates both Encoding Class and Encoding Type. Encoding Class enumerated value (2 most significant bits): 0 = Encoded Voice; 1 = Raw Binary Data; 2 = Application-Specific Data; 3 = Database Index. Encoding Type enumerated value (14 least significant bits): 1 = 8-bit mu-law; 2 = CVSD per MIL-STD-188-113; 3 = ADPCM per CCITT G.721; 4 = 16-bit linear PCM; 5 = 8-bit linear PCM; 6 = Vector Quantization. *

Specified by:

setEncodingScheme in interface SignalPdu

Parameters:

newValue - is new value for the encodingScheme field.

Returns:

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

setEncodingScheme

public SignalPdu setEncodingScheme(SFInt32 newValue)

Assign typed object value to SFInt32 encodingScheme field, similar to setEncodingScheme(int).

Parameters:

newValue - is new value for the encodingScheme field.

Returns:

SignalPdu - 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 SignalPdu

Returns:

value of entityID field

setEntityID

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

Parameters:

newValue - is new value for the entityID field.

Returns:

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

setEntityID

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

SignalPdu - 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 SignalPdu

Returns:

value of geoCoords field

setGeoCoords

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

Parameters:

newValue - is new value for the geoCoords field.

Returns:

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

setGeoCoords

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

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

setGeoCoords

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

SignalPdu - 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 SignalPdu

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 SignalPdu 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 SignalPdu

Parameters:

newValue - is new value for the geoSystem field.

Returns:

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

setGeoSystem

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

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

setGeoSystem

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

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

setGeoSystem

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

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

setGeoSystem

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

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

clearGeoSystem

public SignalPdu clearGeoSystem()

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

Returns:

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

addGeoSystem

public SignalPdu addGeoSystem(String newValue)

Add singleton String value to MFString geoSystem field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

addGeoSystem

public SignalPdu addGeoSystem(SFString newValue)

Add singleton SFString value to MFString geoSystem field.

Parameters:

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

Returns:

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

See Also:

• MFString.cleanupEnumerationValues(String)

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

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

Utility method to clear SFNode value of IS field.

Returns:

SignalPdu - 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 SignalPdu

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 SignalPdu

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 SignalPdu

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 SignalPdu

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 SignalPdu

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 SignalPdu

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 SignalPdu 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 SignalPdu

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:

SignalPdu - 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 SignalPdu clearMetadata()

Utility method to clear SFNode value of metadata field.

Returns:

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

setMetadata

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

SignalPdu - 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 SignalPdu

Returns:

value of multicastRelayHost field

setMulticastRelayHost

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

Parameters:

newValue - is new value for the multicastRelayHost field.

Returns:

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

setMulticastRelayHost

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

SignalPdu - 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 SignalPdu

Returns:

value of multicastRelayPort field

setMulticastRelayPort

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

Parameters:

newValue - is new value for the multicastRelayPort field.

Returns:

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

setMulticastRelayPort

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

SignalPdu - 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 SignalPdu

Returns:

value of networkMode field

setNetworkMode

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

Parameters:

newValue - is new value for the networkMode field.

Returns:

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

setNetworkMode

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

SignalPdu - 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 SignalPdu

Returns:

value of port field

setPort

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

Parameters:

newValue - is new value for the port field.

Returns:

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

setPort

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

SignalPdu - 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 SignalPdu

Returns:

value of radioID field

setRadioID

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

Parameters:

newValue - is new value for the radioID field.

Returns:

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

setRadioID

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

SignalPdu - 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 SignalPdu

Returns:

value of readInterval field

setReadInterval

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

Parameters:

newValue - is new value for the readInterval field.

Returns:

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

setReadInterval

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

SignalPdu - 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 SignalPdu

Returns:

value of rtpHeaderExpected field

setRtpHeaderExpected

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

Parameters:

newValue - is new value for the rtpHeaderExpected field.

Returns:

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

setRtpHeaderExpected

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

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

getSampleRate

public int getSampleRate()

Provide int value from inputOutput SFInt32 field named sampleRate.

Tooltip: sampleRate gives either (1) sample rate in samples per second if Encoding Class is encoded audio, or (2) data rate in bits per second for data transmissions. If Encoding Class is database index, sampleRate is set to zero.

• Hint: Wikipedia Nyquist frequency https://en.wikipedia.org/wiki/Nyquist_frequency

Specified by:

getSampleRate in interface SignalPdu

Returns:

value of sampleRate field

setSampleRate

public SignalPdu setSampleRate(int newValue)

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

Tooltip: sampleRate gives either (1) sample rate in samples per second if Encoding Class is encoded audio, or (2) data rate in bits per second for data transmissions. If Encoding Class is database index, sampleRate is set to zero.

• Hint: Wikipedia Nyquist frequency https://en.wikipedia.org/wiki/Nyquist_frequency

Specified by:

setSampleRate in interface SignalPdu

Parameters:

newValue - is new value for the sampleRate field.

Returns:

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

setSampleRate

public SignalPdu setSampleRate(SFInt32 newValue)

Assign typed object value to SFInt32 sampleRate field, similar to setSampleRate(int).

Parameters:

newValue - is new value for the sampleRate field.

Returns:

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

getSamples

public int getSamples()

Provide int value from inputOutput SFInt32 field named samples.

Tooltip: Number of samples in the PDU if the Encoding Class is encoded voice, otherwise the field is set to zero. *

Specified by:

getSamples in interface SignalPdu

Returns:

value of samples field

setSamples

public SignalPdu setSamples(int newValue)

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

Tooltip: Number of samples in the PDU if the Encoding Class is encoded voice, otherwise the field is set to zero. *

Specified by:

setSamples in interface SignalPdu

Parameters:

newValue - is new value for the samples field.

Returns:

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

setSamples

public SignalPdu setSamples(SFInt32 newValue)

Assign typed object value to SFInt32 samples field, similar to setSamples(int).

Parameters:

newValue - is new value for the samples field.

Returns:

SignalPdu - 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 SignalPdu

Returns:

value of siteID field

setSiteID

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

Parameters:

newValue - is new value for the siteID field.

Returns:

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

setSiteID

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

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

getTdlType

public int getTdlType()

Provide int value from inputOutput SFInt32 field named tdlType.

Tooltip: Tactical Data Link (TDL) type as an enumerated value when the Encoding Class is voice, raw binary, application-specific, or database index representation of a TDL message. *

Specified by:

getTdlType in interface SignalPdu

Returns:

value of tdlType field

setTdlType

public SignalPdu setTdlType(int newValue)

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

Tooltip: Tactical Data Link (TDL) type as an enumerated value when the Encoding Class is voice, raw binary, application-specific, or database index representation of a TDL message. *

Specified by:

setTdlType in interface SignalPdu

Parameters:

newValue - is new value for the tdlType field.

Returns:

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

setTdlType

public SignalPdu setTdlType(SFInt32 newValue)

Assign typed object value to SFInt32 tdlType field, similar to setTdlType(int).

Parameters:

newValue - is new value for the tdlType field.

Returns:

SignalPdu - 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 SignalPdu

Returns:

value of timestamp field

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 SignalPdu

Specified by:

getVisible in interface X3DBoundedObject

Returns:

value of visible field

setVisible

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

Specified by:

setVisible in interface X3DBoundedObject

Parameters:

newValue - is new value for the visible field.

Returns:

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

setVisible

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

SignalPdu - 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 SignalPdu

Returns:

value of whichGeometry field

setWhichGeometry

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

Parameters:

newValue - is new value for the whichGeometry field.

Returns:

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

setWhichGeometry

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

SignalPdu - 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 SignalPdu

Returns:

value of writeInterval field

setWriteInterval

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

Parameters:

newValue - is new value for the writeInterval field.

Returns:

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

setWriteInterval

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

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

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

setDEF

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

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

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

setUSE

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

SignalPdu - 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 Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

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

SignalPdu - 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 Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssClass

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

SignalPdu - 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 Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setHtmlID

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

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

SignalPdu - 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 Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

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

SignalPdu - 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 Snapshot
• Wikibooks: XML - Managing Data Exchange/XSLT and Style Sheets

setCssStyle

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

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

setUSE

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

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

addComments

public SignalPdu addComments(String newComment)

Add comment as String to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComment - initial value

Returns:

SignalPdu - 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 SignalPdu addComments(String[] newComments)

Add comments as String[] array to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newComments - array of comments

Returns:

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

addComments

public SignalPdu addComments(CommentsBlock newCommentsBlock)

Add CommentsBlock to contained commentsList.

Specified by:

addComments in class X3DConcreteElement

Parameters:

newCommentsBlock - block of comments to add

Returns:

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