Package org.web3d.x3d.jsail.DIS
Class TransmitterPduObject
java.lang.Object
org.web3d.x3d.jsail.X3DConcreteElement
org.web3d.x3d.jsail.X3DConcreteNode
org.web3d.x3d.jsail.DIS.TransmitterPduObject
- All Implemented Interfaces:
X3DChildNode
,X3DNode
,X3DSensorNode
,TransmitterPdu
,X3DBoundedObject
,X3DNetworkSensorNode
public class TransmitterPduObject extends X3DConcreteNode implements TransmitterPdu
TransmitterPdu is a networked Protocol Data Unit (PDU) information node that provides detailed information about a radio transmitter modeled in a simulation.
X3D node tooltip: [X3DNetworkSensorNode,X3DBoundedObject,X3DVisibleObject] TransmitterPdu is a networked Protocol Data Unit (PDU) information node that provides detailed information about a radio transmitter modeled in a simulation.
Package hint: This org.web3d.x3d.jsail concrete class is used for implementing a standalone X3D object as a Plain Old Java Object (POJO). If you are writing Java code for use inside an X3D Script node, compile separate code using only the org.web3d.x3d.sai package instead.
X3D node tooltip: [X3DNetworkSensorNode,X3DBoundedObject,X3DVisibleObject] TransmitterPdu is a networked Protocol Data Unit (PDU) information node that provides detailed information about a radio transmitter modeled in a simulation.
- Hint: TransmitterPdu 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 http://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.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ADDRESS_DEFAULT_VALUE
SFString field named address has default value "localhost" (Java syntax) or localhost (XML syntax).static float[]
ANTENNALOCATION_DEFAULT_VALUE
SFVec3f field named antennaLocation has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static int
ANTENNAPATTERNLENGTH_DEFAULT_VALUE
SFInt32 field named antennaPatternLength has default value 0 (Java syntax) or 0 (XML syntax).static int
ANTENNAPATTERNTYPE_DEFAULT_VALUE
SFInt32 field named antennaPatternType has default value 0 (Java syntax) or 0 (XML syntax).static int
APPLICATIONID_DEFAULT_VALUE
SFInt32 field named applicationID has default value 0 (Java syntax) or 0 (XML syntax).static float[]
BBOXCENTER_DEFAULT_VALUE
SFVec3f field named bboxCenter has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static boolean
BBOXDISPLAY_DEFAULT_VALUE
SFBool field named bboxDisplay has default value false (Java syntax) or false (XML syntax).static float[]
BBOXSIZE_DEFAULT_VALUE
SFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax).static java.lang.String
COMPONENT
String constant COMPONENT defines X3D component for the TransmitterPdu element: DISstatic java.lang.String
containerField_DEFAULT_VALUE
containerField describes typical field relationship of a node to its parent.static int
CRYPTOKEYID_DEFAULT_VALUE
SFInt32 field named cryptoKeyID has default value 0 (Java syntax) or 0 (XML syntax).static int
CRYPTOSYSTEM_DEFAULT_VALUE
SFInt32 field named cryptoSystem has default value 0 (Java syntax) or 0 (XML syntax).static boolean
ENABLED_DEFAULT_VALUE
SFBool field named enabled has default value true (Java syntax) or true (XML syntax).static int
ENTITYID_DEFAULT_VALUE
SFInt32 field named entityID has default value 0 (Java syntax) or 0 (XML syntax).static int
FREQUENCY_DEFAULT_VALUE
SFInt32 field named frequency has default value 0 (Java syntax) or 0 (XML syntax).static java.lang.String
fromField_ADDRESS
fromField ROUTE name for SFString field named address.static java.lang.String
fromField_ANTENNALOCATION
fromField ROUTE name for SFVec3f field named antennaLocation.static java.lang.String
fromField_ANTENNAPATTERNLENGTH
fromField ROUTE name for SFInt32 field named antennaPatternLength.static java.lang.String
fromField_ANTENNAPATTERNTYPE
fromField ROUTE name for SFInt32 field named antennaPatternType.static java.lang.String
fromField_APPLICATIONID
fromField ROUTE name for SFInt32 field named applicationID.static java.lang.String
fromField_BBOXDISPLAY
fromField ROUTE name for SFBool field named bboxDisplay.static java.lang.String
fromField_CRYPTOKEYID
fromField ROUTE name for SFInt32 field named cryptoKeyID.static java.lang.String
fromField_CRYPTOSYSTEM
fromField ROUTE name for SFInt32 field named cryptoSystem.static java.lang.String
fromField_ENABLED
fromField ROUTE name for SFBool field named enabled.static java.lang.String
fromField_ENTITYID
fromField ROUTE name for SFInt32 field named entityID.static java.lang.String
fromField_FREQUENCY
fromField ROUTE name for SFInt32 field named frequency.static java.lang.String
fromField_GEOCOORDS
fromField ROUTE name for SFVec3d field named geoCoords.static java.lang.String
fromField_INPUTSOURCE
fromField ROUTE name for SFInt32 field named inputSource.static java.lang.String
fromField_IS
fromField ROUTE name for SFNode field named IS.static java.lang.String
fromField_ISACTIVE
fromField ROUTE name for SFBool field named isActive.static java.lang.String
fromField_ISNETWORKREADER
fromField ROUTE name for SFBool field named isNetworkReader.static java.lang.String
fromField_ISNETWORKWRITER
fromField ROUTE name for SFBool field named isNetworkWriter.static java.lang.String
fromField_ISRTPHEADERHEARD
fromField ROUTE name for SFBool field named isRtpHeaderHeard.static java.lang.String
fromField_ISSTANDALONE
fromField ROUTE name for SFBool field named isStandAlone.static java.lang.String
fromField_LENGTHOFMODULATIONPARAMETERS
fromField ROUTE name for SFInt32 field named lengthOfModulationParameters.static java.lang.String
fromField_METADATA
fromField ROUTE name for SFNode field named metadata.static java.lang.String
fromField_MODULATIONTYPEDETAIL
fromField ROUTE name for SFInt32 field named modulationTypeDetail.static java.lang.String
fromField_MODULATIONTYPEMAJOR
fromField ROUTE name for SFInt32 field named modulationTypeMajor.static java.lang.String
fromField_MODULATIONTYPESPREADSPECTRUM
fromField ROUTE name for SFInt32 field named modulationTypeSpreadSpectrum.static java.lang.String
fromField_MODULATIONTYPESYSTEM
fromField ROUTE name for SFInt32 field named modulationTypeSystem.static java.lang.String
fromField_MULTICASTRELAYHOST
fromField ROUTE name for SFString field named multicastRelayHost.static java.lang.String
fromField_MULTICASTRELAYPORT
fromField ROUTE name for SFInt32 field named multicastRelayPort.static java.lang.String
fromField_NETWORKMODE
fromField ROUTE name for SFString field named networkMode.static java.lang.String
fromField_PORT
fromField ROUTE name for SFInt32 field named port.static java.lang.String
fromField_POWER
fromField ROUTE name for SFFloat field named power.static java.lang.String
fromField_RADIOENTITYTYPECATEGORY
fromField ROUTE name for SFInt32 field named radioEntityTypeCategory.static java.lang.String
fromField_RADIOENTITYTYPECOUNTRY
fromField ROUTE name for SFInt32 field named radioEntityTypeCountry.static java.lang.String
fromField_RADIOENTITYTYPEDOMAIN
fromField ROUTE name for SFInt32 field named radioEntityTypeDomain.static java.lang.String
fromField_RADIOENTITYTYPEKIND
fromField ROUTE name for SFInt32 field named radioEntityTypeKind.static java.lang.String
fromField_RADIOENTITYTYPENOMENCLATURE
fromField ROUTE name for SFInt32 field named radioEntityTypeNomenclature.static java.lang.String
fromField_RADIOENTITYTYPENOMENCLATUREVERSION
fromField ROUTE name for SFInt32 field named radioEntityTypeNomenclatureVersion.static java.lang.String
fromField_RADIOID
fromField ROUTE name for SFInt32 field named radioID.static java.lang.String
fromField_READINTERVAL
fromField ROUTE name for SFTime field named readInterval.static java.lang.String
fromField_RELATIVEANTENNALOCATION
fromField ROUTE name for SFVec3f field named relativeAntennaLocation.static java.lang.String
fromField_SITEID
fromField ROUTE name for SFInt32 field named siteID.static java.lang.String
fromField_TIMESTAMP
fromField ROUTE name for SFTime field named timestamp.static java.lang.String
fromField_TRANSMITFREQUENCYBANDWIDTH
fromField ROUTE name for SFFloat field named transmitFrequencyBandwidth.static java.lang.String
fromField_TRANSMITSTATE
fromField ROUTE name for SFInt32 field named transmitState.static java.lang.String
fromField_VISIBLE
fromField ROUTE name for SFBool field named visible.static java.lang.String
fromField_WHICHGEOMETRY
fromField ROUTE name for SFInt32 field named whichGeometry.static java.lang.String
fromField_WRITEINTERVAL
fromField ROUTE name for SFTime field named writeInterval.static double[]
GEOCOORDS_DEFAULT_VALUE
SFVec3d field named geoCoords has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax).static java.util.ArrayList<java.lang.String>
GEOSYSTEM_DEFAULT_VALUE
MFString field named geoSystem has default quoted value new String[] {"GD","WE"} (Java syntax) or quoted value "GD" "WE" (XML syntax).static int
INPUTSOURCE_DEFAULT_VALUE
SFInt32 field named inputSource has default value 0 (Java syntax) or 0 (XML syntax).static ISObject
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax).static int
LENGTHOFMODULATIONPARAMETERS_DEFAULT_VALUE
SFInt32 field named lengthOfModulationParameters has default value 0 (Java syntax) or 0 (XML syntax).static int
LEVEL
Integer constant LEVEL provides default X3D DIS component level for this element: 1static X3DMetadataObject
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax).static int
MODULATIONTYPEDETAIL_DEFAULT_VALUE
SFInt32 field named modulationTypeDetail has default value 0 (Java syntax) or 0 (XML syntax).static int
MODULATIONTYPEMAJOR_DEFAULT_VALUE
SFInt32 field named modulationTypeMajor has default value 0 (Java syntax) or 0 (XML syntax).static int
MODULATIONTYPESPREADSPECTRUM_DEFAULT_VALUE
SFInt32 field named modulationTypeSpreadSpectrum has default value 0 (Java syntax) or 0 (XML syntax).static int
MODULATIONTYPESYSTEM_DEFAULT_VALUE
SFInt32 field named modulationTypeSystem has default value 0 (Java syntax) or 0 (XML syntax).static java.lang.String
MULTICASTRELAYHOST_DEFAULT_VALUE
SFString field named multicastRelayHost has default value equal to an empty string.static int
MULTICASTRELAYPORT_DEFAULT_VALUE
SFInt32 field named multicastRelayPort has default value 0 (Java syntax) or 0 (XML syntax).static java.lang.String
NAME
String constant NAME provides name of this element: TransmitterPdu.static java.lang.String
NETWORKMODE_DEFAULT_VALUE
SFString field named networkMode has default value "standAlone" (Java syntax) or standAlone (XML syntax).static java.lang.String
NETWORKMODE_NETWORKREADER
Tooltip: listen to network and read PDU packets at readInterval, act as remotely linked copy of entity.static java.lang.String
NETWORKMODE_NETWORKWRITER
Tooltip: send PDU packets to network at writeInterval, act as master entity.static java.lang.String
NETWORKMODE_STANDALONE
Tooltip: ignore network but still respond to events in local scene.static int
PORT_DEFAULT_VALUE
SFInt32 field named port has default value 0 (Java syntax) or 0 (XML syntax).static float
POWER_DEFAULT_VALUE
SFFloat field named power has default value 0.0f (Java syntax) or 0.0 (XML syntax).static int
RADIOENTITYTYPECATEGORY_DEFAULT_VALUE
SFInt32 field named radioEntityTypeCategory has default value 0 (Java syntax) or 0 (XML syntax).static int
RADIOENTITYTYPECOUNTRY_DEFAULT_VALUE
SFInt32 field named radioEntityTypeCountry has default value 0 (Java syntax) or 0 (XML syntax).static int
RADIOENTITYTYPEDOMAIN_DEFAULT_VALUE
SFInt32 field named radioEntityTypeDomain has default value 0 (Java syntax) or 0 (XML syntax).static int
RADIOENTITYTYPEKIND_DEFAULT_VALUE
SFInt32 field named radioEntityTypeKind has default value 0 (Java syntax) or 0 (XML syntax).static int
RADIOENTITYTYPENOMENCLATURE_DEFAULT_VALUE
SFInt32 field named radioEntityTypeNomenclature has default value 0 (Java syntax) or 0 (XML syntax).static int
RADIOENTITYTYPENOMENCLATUREVERSION_DEFAULT_VALUE
SFInt32 field named radioEntityTypeNomenclatureVersion has default value 0 (Java syntax) or 0 (XML syntax).static int
RADIOID_DEFAULT_VALUE
SFInt32 field named radioID has default value 0 (Java syntax) or 0 (XML syntax).static double
READINTERVAL_DEFAULT_VALUE
SFTime field named readInterval has default value 0.1 (Java syntax) or 0.1 (XML syntax).static float[]
RELATIVEANTENNALOCATION_DEFAULT_VALUE
SFVec3f field named relativeAntennaLocation has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax).static boolean
RTPHEADEREXPECTED_DEFAULT_VALUE
SFBool field named rtpHeaderExpected has default value false (Java syntax) or false (XML syntax).static int
SITEID_DEFAULT_VALUE
SFInt32 field named siteID has default value 0 (Java syntax) or 0 (XML syntax).static java.lang.String
toField_ADDRESS
toField ROUTE name for SFString field named address.static java.lang.String
toField_ANTENNALOCATION
toField ROUTE name for SFVec3f field named antennaLocation.static java.lang.String
toField_ANTENNAPATTERNLENGTH
toField ROUTE name for SFInt32 field named antennaPatternLength.static java.lang.String
toField_ANTENNAPATTERNTYPE
toField ROUTE name for SFInt32 field named antennaPatternType.static java.lang.String
toField_APPLICATIONID
toField ROUTE name for SFInt32 field named applicationID.static java.lang.String
toField_BBOXDISPLAY
toField ROUTE name for SFBool field named bboxDisplay.static java.lang.String
toField_CRYPTOKEYID
toField ROUTE name for SFInt32 field named cryptoKeyID.static java.lang.String
toField_CRYPTOSYSTEM
toField ROUTE name for SFInt32 field named cryptoSystem.static java.lang.String
toField_ENABLED
toField ROUTE name for SFBool field named enabled.static java.lang.String
toField_ENTITYID
toField ROUTE name for SFInt32 field named entityID.static java.lang.String
toField_FREQUENCY
toField ROUTE name for SFInt32 field named frequency.static java.lang.String
toField_GEOCOORDS
toField ROUTE name for SFVec3d field named geoCoords.static java.lang.String
toField_INPUTSOURCE
toField ROUTE name for SFInt32 field named inputSource.static java.lang.String
toField_LENGTHOFMODULATIONPARAMETERS
toField ROUTE name for SFInt32 field named lengthOfModulationParameters.static java.lang.String
toField_METADATA
toField ROUTE name for SFNode field named metadata.static java.lang.String
toField_MODULATIONTYPEDETAIL
toField ROUTE name for SFInt32 field named modulationTypeDetail.static java.lang.String
toField_MODULATIONTYPEMAJOR
toField ROUTE name for SFInt32 field named modulationTypeMajor.static java.lang.String
toField_MODULATIONTYPESPREADSPECTRUM
toField ROUTE name for SFInt32 field named modulationTypeSpreadSpectrum.static java.lang.String
toField_MODULATIONTYPESYSTEM
toField ROUTE name for SFInt32 field named modulationTypeSystem.static java.lang.String
toField_MULTICASTRELAYHOST
toField ROUTE name for SFString field named multicastRelayHost.static java.lang.String
toField_MULTICASTRELAYPORT
toField ROUTE name for SFInt32 field named multicastRelayPort.static java.lang.String
toField_NETWORKMODE
toField ROUTE name for SFString field named networkMode.static java.lang.String
toField_PORT
toField ROUTE name for SFInt32 field named port.static java.lang.String
toField_POWER
toField ROUTE name for SFFloat field named power.static java.lang.String
toField_RADIOENTITYTYPECATEGORY
toField ROUTE name for SFInt32 field named radioEntityTypeCategory.static java.lang.String
toField_RADIOENTITYTYPECOUNTRY
toField ROUTE name for SFInt32 field named radioEntityTypeCountry.static java.lang.String
toField_RADIOENTITYTYPEDOMAIN
toField ROUTE name for SFInt32 field named radioEntityTypeDomain.static java.lang.String
toField_RADIOENTITYTYPEKIND
toField ROUTE name for SFInt32 field named radioEntityTypeKind.static java.lang.String
toField_RADIOENTITYTYPENOMENCLATURE
toField ROUTE name for SFInt32 field named radioEntityTypeNomenclature.static java.lang.String
toField_RADIOENTITYTYPENOMENCLATUREVERSION
toField ROUTE name for SFInt32 field named radioEntityTypeNomenclatureVersion.static java.lang.String
toField_RADIOID
toField ROUTE name for SFInt32 field named radioID.static java.lang.String
toField_READINTERVAL
toField ROUTE name for SFTime field named readInterval.static java.lang.String
toField_RELATIVEANTENNALOCATION
toField ROUTE name for SFVec3f field named relativeAntennaLocation.static java.lang.String
toField_SITEID
toField ROUTE name for SFInt32 field named siteID.static java.lang.String
toField_TRANSMITFREQUENCYBANDWIDTH
toField ROUTE name for SFFloat field named transmitFrequencyBandwidth.static java.lang.String
toField_TRANSMITSTATE
toField ROUTE name for SFInt32 field named transmitState.static java.lang.String
toField_VISIBLE
toField ROUTE name for SFBool field named visible.static java.lang.String
toField_WHICHGEOMETRY
toField ROUTE name for SFInt32 field named whichGeometry.static java.lang.String
toField_WRITEINTERVAL
toField ROUTE name for SFTime field named writeInterval.static float
TRANSMITFREQUENCYBANDWIDTH_DEFAULT_VALUE
SFFloat field named transmitFrequencyBandwidth has default value 0f (Java syntax) or 0 (XML syntax).static int
TRANSMITSTATE_DEFAULT_VALUE
SFInt32 field named transmitState has default value 0 (Java syntax) or 0 (XML syntax).static boolean
VISIBLE_DEFAULT_VALUE
SFBool field named visible has default value true (Java syntax) or true (XML syntax).static int
WHICHGEOMETRY_DEFAULT_VALUE
SFInt32 field named whichGeometry has default value 1 (Java syntax) or 1 (XML syntax).static 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
CLASS_DEFAULT_VALUE, containerField_ALTERNATE_VALUES, DEF_DEFAULT_VALUE, USE_DEFAULT_VALUE
-
Constructor Summary
Constructors Constructor Description TransmitterPduObject()
Constructor for TransmitterPduObject to initialize member variables with default values.TransmitterPduObject(java.lang.String DEFlabel)
Utility constructor that assigns DEF label after initializing member variables with default values. -
Method Summary
Modifier and Type Method Description TransmitterPduObject
addComments(java.lang.String newComment)
Add comment as String to contained commentsList.TransmitterPduObject
addComments(java.lang.String[] newComments)
Add comments as String[] array to contained commentsList.TransmitterPduObject
addComments(CommentsBlock newCommentsBlock)
Add CommentsBlock to contained commentsList.TransmitterPduObject
addGeoSystem(java.lang.String newValue)
Add singleton String value to MFString geoSystem field.TransmitterPduObject
addGeoSystem(SFStringObject newValue)
Add singleton SFStringObject value to MFString geoSystem field.TransmitterPduObject
clearGeoSystem()
Utility method to clear MFString value of geoSystem field.TransmitterPduObject
clearIS()
Utility method to clear SFNode value of IS field.TransmitterPduObject
clearMetadata()
Utility method to clear SFNode value of metadata field.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteElement
findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element.X3DConcreteNode
findNodeByDEF(java.lang.String DEFvalue)
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.java.lang.String
getAccessType(java.lang.String fieldName)
Indicate accessType corresponding to given fieldName.java.lang.String
getAddress()
Provide String value from inputOutput SFString field named address.float[]
getAntennaLocation()
Provide array of 3-tuple float results from inputOutput SFVec3f field named antennaLocation.int
getAntennaPatternLength()
Provide int value from inputOutput SFInt32 field named antennaPatternLength.int
getAntennaPatternType()
Provide int value from inputOutput SFInt32 field named antennaPatternType.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.java.lang.String
getComponent()
Defines X3D component for the TransmitterPdu element: DISint
getComponentLevel()
Provides default X3D component level for this element: 1java.lang.String
getContainerFieldDefault()
containerField describes typical field relationship of a node to its parent.int
getCryptoKeyID()
Provide int value from inputOutput SFInt32 field named cryptoKeyID.int
getCryptoSystem()
Provide int value from inputOutput SFInt32 field named cryptoSystem.java.lang.String
getCssClass()
Provide String value from inputOutput SFString field named class.java.lang.String
getDEF()
Provide String value from inputOutput SFString field named DEF.java.lang.String
getElementName()
Provides name of this element: TransmitterPduboolean
getEnabled()
Provide boolean value from inputOutput SFBool field named enabled.int
getEntityID()
Provide int value from inputOutput SFInt32 field named entityID.java.lang.String
getFieldType(java.lang.String fieldName)
Indicate type corresponding to given fieldName.int
getFrequency()
Provide int value from inputOutput SFInt32 field named frequency.double[]
getGeoCoords()
Provide array of 3-tuple double results from inputOutput SFVec3d field named geoCoords.java.lang.String[]
getGeoSystem()
Provide array of String results from initializeOnly MFString field named geoSystem.java.util.ArrayList<java.lang.String>
getGeoSystemList()
Utility method to get ArrayList value of MFString geoSystem field, similar togetGeoSystem()
.java.lang.String
getGeoSystemString()
Utility method to get String value of MFString geoSystem field, similar togetGeoSystem()
.int
getInputSource()
Provide int value from inputOutput SFInt32 field named inputSource.ISObject
getIS()
Provide ISObject 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.int
getLengthOfModulationParameters()
Provide int value from inputOutput SFInt32 field named lengthOfModulationParameters.X3DMetadataObject
getMetadata()
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.int
getModulationTypeDetail()
Provide int value from inputOutput SFInt32 field named modulationTypeDetail.int
getModulationTypeMajor()
Provide int value from inputOutput SFInt32 field named modulationTypeMajor.int
getModulationTypeSpreadSpectrum()
Provide int value from inputOutput SFInt32 field named modulationTypeSpreadSpectrum.int
getModulationTypeSystem()
Provide int value from inputOutput SFInt32 field named modulationTypeSystem.java.lang.String
getMulticastRelayHost()
Provide String value from inputOutput SFString field named multicastRelayHost.int
getMulticastRelayPort()
Provide int value from inputOutput SFInt32 field named multicastRelayPort.java.lang.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.float
getPower()
Provide float value from inputOutput SFFloat field named power.int
getRadioEntityTypeCategory()
Provide int value from inputOutput SFInt32 field named radioEntityTypeCategory.int
getRadioEntityTypeCountry()
Provide int value from inputOutput SFInt32 field named radioEntityTypeCountry.int
getRadioEntityTypeDomain()
Provide int value from inputOutput SFInt32 field named radioEntityTypeDomain.int
getRadioEntityTypeKind()
Provide int value from inputOutput SFInt32 field named radioEntityTypeKind.int
getRadioEntityTypeNomenclature()
Provide int value from inputOutput SFInt32 field named radioEntityTypeNomenclature.int
getRadioEntityTypeNomenclatureVersion()
Provide int value from inputOutput SFInt32 field named radioEntityTypeNomenclatureVersion.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.float[]
getRelativeAntennaLocation()
Provide array of 3-tuple float results from inputOutput SFVec3f field named relativeAntennaLocation.boolean
getRtpHeaderExpected()
Provide boolean value from initializeOnly SFBool field named rtpHeaderExpected.int
getSiteID()
Provide int value from inputOutput SFInt32 field named siteID.double
getTimestamp()
Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named timestamp.float
getTransmitFrequencyBandwidth()
Provide float value from inputOutput SFFloat field named transmitFrequencyBandwidth.int
getTransmitState()
Provide int value from inputOutput SFInt32 field named transmitState.java.lang.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(java.lang.String nameValue, java.lang.String elementName)
Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.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(java.lang.String DEFvalue)
Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.void
initialize()
Initialize all member variables to default values.TransmitterPduObject
setAddress(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named address.TransmitterPduObject
setAddress(SFStringObject newValue)
Assign typed object value to SFString address field, similar tosetAddress(String)
.TransmitterPduObject
setAntennaLocation(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetAntennaLocation(float[])
.TransmitterPduObject
setAntennaLocation(double x, double y, double z)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetAntennaLocation(float[])
.TransmitterPduObject
setAntennaLocation(float[] newValue)
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named antennaLocation.TransmitterPduObject
setAntennaLocation(float x, float y, float z)
Assign values to SFVec3f antennaLocation field, similar tosetAntennaLocation(float[])
.TransmitterPduObject
setAntennaLocation(SFVec3fObject newValue)
Assign typed object value to SFVec3f antennaLocation field, similar tosetAntennaLocation(float[])
.TransmitterPduObject
setAntennaPatternLength(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named antennaPatternLength.TransmitterPduObject
setAntennaPatternLength(SFInt32Object newValue)
Assign typed object value to SFInt32 antennaPatternLength field, similar tosetAntennaPatternLength(int)
.TransmitterPduObject
setAntennaPatternType(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named antennaPatternType.TransmitterPduObject
setAntennaPatternType(SFInt32Object newValue)
Assign typed object value to SFInt32 antennaPatternType field, similar tosetAntennaPatternType(int)
.TransmitterPduObject
setApplicationID(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named applicationID.TransmitterPduObject
setApplicationID(SFInt32Object newValue)
Assign typed object value to SFInt32 applicationID field, similar tosetApplicationID(int)
.TransmitterPduObject
setBboxCenter(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.TransmitterPduObject
setBboxCenter(double x, double y, double z)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.TransmitterPduObject
setBboxCenter(float[] newValue)
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxCenter.TransmitterPduObject
setBboxCenter(float x, float y, float z)
Assign values to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.TransmitterPduObject
setBboxCenter(SFVec3fObject newValue)
Assign typed object value to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.TransmitterPduObject
setBboxDisplay(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named bboxDisplay.TransmitterPduObject
setBboxDisplay(SFBoolObject newValue)
Assign typed object value to SFBool bboxDisplay field, similar tosetBboxDisplay(boolean)
.TransmitterPduObject
setBboxSize(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxSize(float[])
.TransmitterPduObject
setBboxSize(double x, double y, double z)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxSize(float[])
.TransmitterPduObject
setBboxSize(float[] newValue)
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.TransmitterPduObject
setBboxSize(float x, float y, float z)
Assign values to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.TransmitterPduObject
setBboxSize(SFVec3fObject newValue)
Assign typed object value to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.TransmitterPduObject
setCryptoKeyID(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named cryptoKeyID.TransmitterPduObject
setCryptoKeyID(SFInt32Object newValue)
Assign typed object value to SFInt32 cryptoKeyID field, similar tosetCryptoKeyID(int)
.TransmitterPduObject
setCryptoSystem(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named cryptoSystem.TransmitterPduObject
setCryptoSystem(SFInt32Object newValue)
Assign typed object value to SFInt32 cryptoSystem field, similar tosetCryptoSystem(int)
.TransmitterPduObject
setCssClass(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named class.TransmitterPduObject
setCssClass(SFStringObject newValue)
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.TransmitterPduObject
setDEF(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named DEF.TransmitterPduObject
setDEF(SFStringObject newValue)
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.TransmitterPduObject
setEnabled(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named enabled.TransmitterPduObject
setEnabled(SFBoolObject newValue)
Assign typed object value to SFBool enabled field, similar tosetEnabled(boolean)
.TransmitterPduObject
setEntityID(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named entityID.TransmitterPduObject
setEntityID(SFInt32Object newValue)
Assign typed object value to SFInt32 entityID field, similar tosetEntityID(int)
.TransmitterPduObject
setFrequency(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named frequency.TransmitterPduObject
setFrequency(SFInt32Object newValue)
Assign typed object value to SFInt32 frequency field, similar tosetFrequency(int)
.TransmitterPduObject
setGeoCoords(double[] newValue)
Accessor method to assign 3-tuple double array to inputOutput SFVec3d field named geoCoords.TransmitterPduObject
setGeoCoords(double x, double y, double z)
Assign values to SFVec3d geoCoords field, similar tosetGeoCoords(double[])
.TransmitterPduObject
setGeoCoords(SFVec3dObject newValue)
Assign typed object value to SFVec3d geoCoords field, similar tosetGeoCoords(double[])
.TransmitterPduObject
setGeoSystem(java.lang.String newValue)
Assign singleton String value to MFString geoSystem field, similar tosetGeoSystem(String[])
.TransmitterPduObject
setGeoSystem(java.lang.String[] newValue)
Accessor method to assign String array to initializeOnly MFString field named geoSystem.TransmitterPduObject
setGeoSystem(java.util.ArrayList<java.lang.String> newValue)
Assign ArrayList value of MFString geoSystem field, similar tosetGeoSystem(String[])
.TransmitterPduObject
setGeoSystem(MFStringObject newValue)
Assign typed object value to MFString geoSystem field, similar tosetGeoSystem(String[])
.TransmitterPduObject
setGeoSystem(SFStringObject newValue)
Assign single SFString object value to MFString geoSystem field, similar tosetGeoSystem(String[])
.TransmitterPduObject
setInputSource(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named inputSource.TransmitterPduObject
setInputSource(SFInt32Object newValue)
Assign typed object value to SFInt32 inputSource field, similar tosetInputSource(int)
.TransmitterPduObject
setIS(ISObject newValue)
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.TransmitterPduObject
setLengthOfModulationParameters(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named lengthOfModulationParameters.TransmitterPduObject
setLengthOfModulationParameters(SFInt32Object newValue)
Assign typed object value to SFInt32 lengthOfModulationParameters field, similar tosetLengthOfModulationParameters(int)
.TransmitterPduObject
setMetadata(ProtoInstanceObject newValue)
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.TransmitterPduObject
setMetadata(X3DMetadataObject newValue)
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.TransmitterPduObject
setModulationTypeDetail(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named modulationTypeDetail.TransmitterPduObject
setModulationTypeDetail(SFInt32Object newValue)
Assign typed object value to SFInt32 modulationTypeDetail field, similar tosetModulationTypeDetail(int)
.TransmitterPduObject
setModulationTypeMajor(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named modulationTypeMajor.TransmitterPduObject
setModulationTypeMajor(SFInt32Object newValue)
Assign typed object value to SFInt32 modulationTypeMajor field, similar tosetModulationTypeMajor(int)
.TransmitterPduObject
setModulationTypeSpreadSpectrum(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named modulationTypeSpreadSpectrum.TransmitterPduObject
setModulationTypeSpreadSpectrum(SFInt32Object newValue)
Assign typed object value to SFInt32 modulationTypeSpreadSpectrum field, similar tosetModulationTypeSpreadSpectrum(int)
.TransmitterPduObject
setModulationTypeSystem(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named modulationTypeSystem.TransmitterPduObject
setModulationTypeSystem(SFInt32Object newValue)
Assign typed object value to SFInt32 modulationTypeSystem field, similar tosetModulationTypeSystem(int)
.TransmitterPduObject
setMulticastRelayHost(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named multicastRelayHost.TransmitterPduObject
setMulticastRelayHost(SFStringObject newValue)
Assign typed object value to SFString multicastRelayHost field, similar tosetMulticastRelayHost(String)
.TransmitterPduObject
setMulticastRelayPort(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named multicastRelayPort.TransmitterPduObject
setMulticastRelayPort(SFInt32Object newValue)
Assign typed object value to SFInt32 multicastRelayPort field, similar tosetMulticastRelayPort(int)
.TransmitterPduObject
setNetworkMode(java.lang.String newValue)
Accessor method to assign String enumeration value ("standAlone" | "networkReader" | "networkWriter") to inputOutput SFString field named networkMode.TransmitterPduObject
setNetworkMode(SFStringObject newValue)
Assign typed object value to SFString networkMode field, similar tosetNetworkMode(String)
.TransmitterPduObject
setPort(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named port.TransmitterPduObject
setPort(SFInt32Object newValue)
Assign typed object value to SFInt32 port field, similar tosetPort(int)
.TransmitterPduObject
setPower(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetPower(float)
.TransmitterPduObject
setPower(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named power.TransmitterPduObject
setPower(SFFloatObject newValue)
Assign typed object value to SFFloat power field, similar tosetPower(float)
.TransmitterPduObject
setRadioEntityTypeCategory(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeCategory.TransmitterPduObject
setRadioEntityTypeCategory(SFInt32Object newValue)
Assign typed object value to SFInt32 radioEntityTypeCategory field, similar tosetRadioEntityTypeCategory(int)
.TransmitterPduObject
setRadioEntityTypeCountry(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeCountry.TransmitterPduObject
setRadioEntityTypeCountry(SFInt32Object newValue)
Assign typed object value to SFInt32 radioEntityTypeCountry field, similar tosetRadioEntityTypeCountry(int)
.TransmitterPduObject
setRadioEntityTypeDomain(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeDomain.TransmitterPduObject
setRadioEntityTypeDomain(SFInt32Object newValue)
Assign typed object value to SFInt32 radioEntityTypeDomain field, similar tosetRadioEntityTypeDomain(int)
.TransmitterPduObject
setRadioEntityTypeKind(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeKind.TransmitterPduObject
setRadioEntityTypeKind(SFInt32Object newValue)
Assign typed object value to SFInt32 radioEntityTypeKind field, similar tosetRadioEntityTypeKind(int)
.TransmitterPduObject
setRadioEntityTypeNomenclature(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeNomenclature.TransmitterPduObject
setRadioEntityTypeNomenclature(SFInt32Object newValue)
Assign typed object value to SFInt32 radioEntityTypeNomenclature field, similar tosetRadioEntityTypeNomenclature(int)
.TransmitterPduObject
setRadioEntityTypeNomenclatureVersion(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeNomenclatureVersion.TransmitterPduObject
setRadioEntityTypeNomenclatureVersion(SFInt32Object newValue)
Assign typed object value to SFInt32 radioEntityTypeNomenclatureVersion field, similar tosetRadioEntityTypeNomenclatureVersion(int)
.TransmitterPduObject
setRadioID(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named radioID.TransmitterPduObject
setRadioID(SFInt32Object newValue)
Assign typed object value to SFInt32 radioID field, similar tosetRadioID(int)
.TransmitterPduObject
setReadInterval(double newValue)
Accessor method to assign double value in seconds to inputOutput SFTime field named readInterval.TransmitterPduObject
setReadInterval(SFTimeObject newValue)
Assign typed object value to SFTime readInterval field, similar tosetReadInterval(double)
.TransmitterPduObject
setRelativeAntennaLocation(double[] newArray)
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetRelativeAntennaLocation(float[])
.TransmitterPduObject
setRelativeAntennaLocation(double x, double y, double z)
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetRelativeAntennaLocation(float[])
.TransmitterPduObject
setRelativeAntennaLocation(float[] newValue)
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named relativeAntennaLocation.TransmitterPduObject
setRelativeAntennaLocation(float x, float y, float z)
Assign values to SFVec3f relativeAntennaLocation field, similar tosetRelativeAntennaLocation(float[])
.TransmitterPduObject
setRelativeAntennaLocation(SFVec3fObject newValue)
Assign typed object value to SFVec3f relativeAntennaLocation field, similar tosetRelativeAntennaLocation(float[])
.TransmitterPduObject
setRtpHeaderExpected(boolean newValue)
Accessor method to assign boolean value to initializeOnly SFBool field named rtpHeaderExpected.TransmitterPduObject
setRtpHeaderExpected(SFBoolObject newValue)
Assign typed object value to SFBool rtpHeaderExpected field, similar tosetRtpHeaderExpected(boolean)
.TransmitterPduObject
setSiteID(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named siteID.TransmitterPduObject
setSiteID(SFInt32Object newValue)
Assign typed object value to SFInt32 siteID field, similar tosetSiteID(int)
.TransmitterPduObject
setTransmitFrequencyBandwidth(double newValue)
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetTransmitFrequencyBandwidth(float)
.TransmitterPduObject
setTransmitFrequencyBandwidth(float newValue)
Accessor method to assign float value to inputOutput SFFloat field named transmitFrequencyBandwidth.TransmitterPduObject
setTransmitFrequencyBandwidth(SFFloatObject newValue)
Assign typed object value to SFFloat transmitFrequencyBandwidth field, similar tosetTransmitFrequencyBandwidth(float)
.TransmitterPduObject
setTransmitState(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named transmitState.TransmitterPduObject
setTransmitState(SFInt32Object newValue)
Assign typed object value to SFInt32 transmitState field, similar tosetTransmitState(int)
.TransmitterPduObject
setUSE(java.lang.String newValue)
Accessor method to assign String value to inputOutput SFString field named USE.TransmitterPduObject
setUSE(TransmitterPduObject DEFnode)
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.TransmitterPduObject
setUSE(SFStringObject newValue)
Assign typed object value to SFString USE field, similar tosetUSE(String)
.TransmitterPduObject
setVisible(boolean newValue)
Accessor method to assign boolean value to inputOutput SFBool field named visible.TransmitterPduObject
setVisible(SFBoolObject newValue)
Assign typed object value to SFBool visible field, similar tosetVisible(boolean)
.TransmitterPduObject
setWhichGeometry(int newValue)
Accessor method to assign int value to inputOutput SFInt32 field named whichGeometry.TransmitterPduObject
setWhichGeometry(SFInt32Object newValue)
Assign typed object value to SFInt32 whichGeometry field, similar tosetWhichGeometry(int)
.TransmitterPduObject
setWriteInterval(double newValue)
Accessor method to assign double value in seconds to inputOutput SFTime field named writeInterval.TransmitterPduObject
setWriteInterval(SFTimeObject newValue)
Assign typed object value to SFTime writeInterval field, similar tosetWriteInterval(double)
.java.lang.String
toStringClassicVRML(int indentLevel)
Recursive method to provide ClassicVRML string serialization.java.lang.String
toStringVRML97(int indentLevel)
Recursive method to provide VRML97 string serialization.java.lang.String
toStringX3D(int indentLevel)
Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.java.lang.String
validate()
Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.Methods inherited from class org.web3d.x3d.jsail.X3DConcreteNode
getContainerFieldAlternateValues, getContainerFieldOverride, isNode, isStatement, isUSE, resetContainerFieldOverride, setConcreteCssClass, setConcreteDEF, setConcreteUSE, setContainerFieldOverride
Methods inherited from class org.web3d.x3d.jsail.X3DConcreteElement
clearParentObject, findAncestorElementByName, findAncestorProtoBody, findAncestorSceneObject, findAncestorX3DObject, getPackageName, getParentObject, getValidationResult, hasAncestorElementByName, hasAncestorProtoBody, hasAncestorSceneObject, hasAncestorX3DObject, hasParentObject, isValid, setParentObject, toStringClassicVRML, toStringVRML97, toStringX3D
-
Field Details
-
NETWORKMODE_STANDALONE
public static final java.lang.String NETWORKMODE_STANDALONETooltip: 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). -
NETWORKMODE_NETWORKREADER
public static final java.lang.String NETWORKMODE_NETWORKREADERTooltip: 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). -
NETWORKMODE_NETWORKWRITER
public static final java.lang.String NETWORKMODE_NETWORKWRITERTooltip: 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). -
NAME
public static final java.lang.String NAMEString constant NAME provides name of this element: TransmitterPdu.- See Also:
- Constant Field Values
-
COMPONENT
public static final java.lang.String COMPONENTString constant COMPONENT defines X3D component for the TransmitterPdu element: DIS- See Also:
- Constant Field Values
-
LEVEL
public static final int LEVELInteger constant LEVEL provides default X3D DIS component level for this element: 1- See Also:
- Constant Field Values
-
ADDRESS_DEFAULT_VALUE
public static final java.lang.String ADDRESS_DEFAULT_VALUESFString field named address has default value "localhost" (Java syntax) or localhost (XML syntax).- See Also:
- Constant Field Values
-
ANTENNALOCATION_DEFAULT_VALUE
public static final float[] ANTENNALOCATION_DEFAULT_VALUESFVec3f field named antennaLocation has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
ANTENNAPATTERNLENGTH_DEFAULT_VALUE
public static final int ANTENNAPATTERNLENGTH_DEFAULT_VALUESFInt32 field named antennaPatternLength has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
ANTENNAPATTERNTYPE_DEFAULT_VALUE
public static final int ANTENNAPATTERNTYPE_DEFAULT_VALUESFInt32 field named antennaPatternType has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
APPLICATIONID_DEFAULT_VALUE
public static final int APPLICATIONID_DEFAULT_VALUESFInt32 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_VALUESFVec3f 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_VALUESFBool 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_VALUESFVec3f field named bboxSize has default value {-1f,-1f,-1f} (Java syntax) or -1 -1 -1 (XML syntax). -
CRYPTOKEYID_DEFAULT_VALUE
public static final int CRYPTOKEYID_DEFAULT_VALUESFInt32 field named cryptoKeyID has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
CRYPTOSYSTEM_DEFAULT_VALUE
public static final int CRYPTOSYSTEM_DEFAULT_VALUESFInt32 field named cryptoSystem has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
ENABLED_DEFAULT_VALUE
public static final boolean ENABLED_DEFAULT_VALUESFBool field named enabled has default value true (Java syntax) or true (XML syntax).- See Also:
- Constant Field Values
-
ENTITYID_DEFAULT_VALUE
public static final int ENTITYID_DEFAULT_VALUESFInt32 field named entityID has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
FREQUENCY_DEFAULT_VALUE
public static final int FREQUENCY_DEFAULT_VALUESFInt32 field named frequency has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
GEOCOORDS_DEFAULT_VALUE
public static final double[] GEOCOORDS_DEFAULT_VALUESFVec3d field named geoCoords has default value {0,0,0} (Java syntax) or 0 0 0 (XML syntax). -
GEOSYSTEM_DEFAULT_VALUE
public static final java.util.ArrayList<java.lang.String> GEOSYSTEM_DEFAULT_VALUEMFString field named geoSystem has default quoted value new String[] {"GD","WE"} (Java syntax) or quoted value "GD" "WE" (XML syntax). -
INPUTSOURCE_DEFAULT_VALUE
public static final int INPUTSOURCE_DEFAULT_VALUESFInt32 field named inputSource has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
IS_DEFAULT_VALUE
SFNode field named IS has default value null (Java syntax) or NULL (XML syntax). -
LENGTHOFMODULATIONPARAMETERS_DEFAULT_VALUE
public static final int LENGTHOFMODULATIONPARAMETERS_DEFAULT_VALUESFInt32 field named lengthOfModulationParameters has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
METADATA_DEFAULT_VALUE
SFNode field named metadata has default value null (Java syntax) or NULL (XML syntax). -
MODULATIONTYPEDETAIL_DEFAULT_VALUE
public static final int MODULATIONTYPEDETAIL_DEFAULT_VALUESFInt32 field named modulationTypeDetail has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
MODULATIONTYPEMAJOR_DEFAULT_VALUE
public static final int MODULATIONTYPEMAJOR_DEFAULT_VALUESFInt32 field named modulationTypeMajor has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
MODULATIONTYPESPREADSPECTRUM_DEFAULT_VALUE
public static final int MODULATIONTYPESPREADSPECTRUM_DEFAULT_VALUESFInt32 field named modulationTypeSpreadSpectrum has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
MODULATIONTYPESYSTEM_DEFAULT_VALUE
public static final int MODULATIONTYPESYSTEM_DEFAULT_VALUESFInt32 field named modulationTypeSystem has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
MULTICASTRELAYHOST_DEFAULT_VALUE
public static final java.lang.String MULTICASTRELAYHOST_DEFAULT_VALUESFString 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_VALUESFInt32 field named multicastRelayPort has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
NETWORKMODE_DEFAULT_VALUE
public static final java.lang.String NETWORKMODE_DEFAULT_VALUESFString 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_VALUESFInt32 field named port has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
POWER_DEFAULT_VALUE
public static final float POWER_DEFAULT_VALUESFFloat field named power has default value 0.0f (Java syntax) or 0.0 (XML syntax).- See Also:
- Constant Field Values
-
RADIOENTITYTYPECATEGORY_DEFAULT_VALUE
public static final int RADIOENTITYTYPECATEGORY_DEFAULT_VALUESFInt32 field named radioEntityTypeCategory has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
RADIOENTITYTYPECOUNTRY_DEFAULT_VALUE
public static final int RADIOENTITYTYPECOUNTRY_DEFAULT_VALUESFInt32 field named radioEntityTypeCountry has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
RADIOENTITYTYPEDOMAIN_DEFAULT_VALUE
public static final int RADIOENTITYTYPEDOMAIN_DEFAULT_VALUESFInt32 field named radioEntityTypeDomain has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
RADIOENTITYTYPEKIND_DEFAULT_VALUE
public static final int RADIOENTITYTYPEKIND_DEFAULT_VALUESFInt32 field named radioEntityTypeKind has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
RADIOENTITYTYPENOMENCLATURE_DEFAULT_VALUE
public static final int RADIOENTITYTYPENOMENCLATURE_DEFAULT_VALUESFInt32 field named radioEntityTypeNomenclature has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
RADIOENTITYTYPENOMENCLATUREVERSION_DEFAULT_VALUE
public static final int RADIOENTITYTYPENOMENCLATUREVERSION_DEFAULT_VALUESFInt32 field named radioEntityTypeNomenclatureVersion has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
RADIOID_DEFAULT_VALUE
public static final int RADIOID_DEFAULT_VALUESFInt32 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_VALUESFTime field named readInterval has default value 0.1 (Java syntax) or 0.1 (XML syntax).- See Also:
- Constant Field Values
-
RELATIVEANTENNALOCATION_DEFAULT_VALUE
public static final float[] RELATIVEANTENNALOCATION_DEFAULT_VALUESFVec3f field named relativeAntennaLocation has default value {0f,0f,0f} (Java syntax) or 0 0 0 (XML syntax). -
RTPHEADEREXPECTED_DEFAULT_VALUE
public static final boolean RTPHEADEREXPECTED_DEFAULT_VALUESFBool field named rtpHeaderExpected has default value false (Java syntax) or false (XML syntax).- See Also:
- Constant Field Values
-
SITEID_DEFAULT_VALUE
public static final int SITEID_DEFAULT_VALUESFInt32 field named siteID has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
TRANSMITFREQUENCYBANDWIDTH_DEFAULT_VALUE
public static final float TRANSMITFREQUENCYBANDWIDTH_DEFAULT_VALUESFFloat field named transmitFrequencyBandwidth has default value 0f (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
TRANSMITSTATE_DEFAULT_VALUE
public static final int TRANSMITSTATE_DEFAULT_VALUESFInt32 field named transmitState has default value 0 (Java syntax) or 0 (XML syntax).- See Also:
- Constant Field Values
-
VISIBLE_DEFAULT_VALUE
public static final boolean VISIBLE_DEFAULT_VALUESFBool 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_VALUESFInt32 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_VALUESFTime 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 java.lang.String containerField_DEFAULT_VALUEcontainerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes. -
fromField_ADDRESS
public static final java.lang.String fromField_ADDRESSfromField ROUTE name for SFString field named address.- See Also:
- Constant Field Values
-
toField_ADDRESS
public static final java.lang.String toField_ADDRESStoField ROUTE name for SFString field named address.- See Also:
- Constant Field Values
-
fromField_ANTENNALOCATION
public static final java.lang.String fromField_ANTENNALOCATIONfromField ROUTE name for SFVec3f field named antennaLocation.- See Also:
- Constant Field Values
-
toField_ANTENNALOCATION
public static final java.lang.String toField_ANTENNALOCATIONtoField ROUTE name for SFVec3f field named antennaLocation.- See Also:
- Constant Field Values
-
fromField_ANTENNAPATTERNLENGTH
public static final java.lang.String fromField_ANTENNAPATTERNLENGTHfromField ROUTE name for SFInt32 field named antennaPatternLength.- See Also:
- Constant Field Values
-
toField_ANTENNAPATTERNLENGTH
public static final java.lang.String toField_ANTENNAPATTERNLENGTHtoField ROUTE name for SFInt32 field named antennaPatternLength.- See Also:
- Constant Field Values
-
fromField_ANTENNAPATTERNTYPE
public static final java.lang.String fromField_ANTENNAPATTERNTYPEfromField ROUTE name for SFInt32 field named antennaPatternType.- See Also:
- Constant Field Values
-
toField_ANTENNAPATTERNTYPE
public static final java.lang.String toField_ANTENNAPATTERNTYPEtoField ROUTE name for SFInt32 field named antennaPatternType.- See Also:
- Constant Field Values
-
fromField_APPLICATIONID
public static final java.lang.String fromField_APPLICATIONIDfromField ROUTE name for SFInt32 field named applicationID.- See Also:
- Constant Field Values
-
toField_APPLICATIONID
public static final java.lang.String toField_APPLICATIONIDtoField ROUTE name for SFInt32 field named applicationID.- See Also:
- Constant Field Values
-
fromField_BBOXDISPLAY
public static final java.lang.String fromField_BBOXDISPLAYfromField ROUTE name for SFBool field named bboxDisplay.- See Also:
- Constant Field Values
-
toField_BBOXDISPLAY
public static final java.lang.String toField_BBOXDISPLAYtoField ROUTE name for SFBool field named bboxDisplay.- See Also:
- Constant Field Values
-
fromField_CRYPTOKEYID
public static final java.lang.String fromField_CRYPTOKEYIDfromField ROUTE name for SFInt32 field named cryptoKeyID.- See Also:
- Constant Field Values
-
toField_CRYPTOKEYID
public static final java.lang.String toField_CRYPTOKEYIDtoField ROUTE name for SFInt32 field named cryptoKeyID.- See Also:
- Constant Field Values
-
fromField_CRYPTOSYSTEM
public static final java.lang.String fromField_CRYPTOSYSTEMfromField ROUTE name for SFInt32 field named cryptoSystem.- See Also:
- Constant Field Values
-
toField_CRYPTOSYSTEM
public static final java.lang.String toField_CRYPTOSYSTEMtoField ROUTE name for SFInt32 field named cryptoSystem.- See Also:
- Constant Field Values
-
fromField_ENABLED
public static final java.lang.String fromField_ENABLEDfromField ROUTE name for SFBool field named enabled.- See Also:
- Constant Field Values
-
toField_ENABLED
public static final java.lang.String toField_ENABLEDtoField ROUTE name for SFBool field named enabled.- See Also:
- Constant Field Values
-
fromField_ENTITYID
public static final java.lang.String fromField_ENTITYIDfromField ROUTE name for SFInt32 field named entityID.- See Also:
- Constant Field Values
-
toField_ENTITYID
public static final java.lang.String toField_ENTITYIDtoField ROUTE name for SFInt32 field named entityID.- See Also:
- Constant Field Values
-
fromField_FREQUENCY
public static final java.lang.String fromField_FREQUENCYfromField ROUTE name for SFInt32 field named frequency.- See Also:
- Constant Field Values
-
toField_FREQUENCY
public static final java.lang.String toField_FREQUENCYtoField ROUTE name for SFInt32 field named frequency.- See Also:
- Constant Field Values
-
fromField_GEOCOORDS
public static final java.lang.String fromField_GEOCOORDSfromField ROUTE name for SFVec3d field named geoCoords.- See Also:
- Constant Field Values
-
toField_GEOCOORDS
public static final java.lang.String toField_GEOCOORDStoField ROUTE name for SFVec3d field named geoCoords.- See Also:
- Constant Field Values
-
fromField_INPUTSOURCE
public static final java.lang.String fromField_INPUTSOURCEfromField ROUTE name for SFInt32 field named inputSource.- See Also:
- Constant Field Values
-
toField_INPUTSOURCE
public static final java.lang.String toField_INPUTSOURCEtoField ROUTE name for SFInt32 field named inputSource.- See Also:
- Constant Field Values
-
fromField_IS
public static final java.lang.String fromField_ISfromField ROUTE name for SFNode field named IS.- See Also:
- Constant Field Values
-
fromField_ISACTIVE
public static final java.lang.String fromField_ISACTIVEfromField ROUTE name for SFBool field named isActive.- See Also:
- Constant Field Values
-
fromField_ISNETWORKREADER
public static final java.lang.String fromField_ISNETWORKREADERfromField ROUTE name for SFBool field named isNetworkReader.- See Also:
- Constant Field Values
-
fromField_ISNETWORKWRITER
public static final java.lang.String fromField_ISNETWORKWRITERfromField ROUTE name for SFBool field named isNetworkWriter.- See Also:
- Constant Field Values
-
fromField_ISRTPHEADERHEARD
public static final java.lang.String fromField_ISRTPHEADERHEARDfromField ROUTE name for SFBool field named isRtpHeaderHeard.- See Also:
- Constant Field Values
-
fromField_ISSTANDALONE
public static final java.lang.String fromField_ISSTANDALONEfromField ROUTE name for SFBool field named isStandAlone.- See Also:
- Constant Field Values
-
fromField_LENGTHOFMODULATIONPARAMETERS
public static final java.lang.String fromField_LENGTHOFMODULATIONPARAMETERSfromField ROUTE name for SFInt32 field named lengthOfModulationParameters.- See Also:
- Constant Field Values
-
toField_LENGTHOFMODULATIONPARAMETERS
public static final java.lang.String toField_LENGTHOFMODULATIONPARAMETERStoField ROUTE name for SFInt32 field named lengthOfModulationParameters.- See Also:
- Constant Field Values
-
fromField_METADATA
public static final java.lang.String fromField_METADATAfromField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
toField_METADATA
public static final java.lang.String toField_METADATAtoField ROUTE name for SFNode field named metadata.- See Also:
- Constant Field Values
-
fromField_MODULATIONTYPEDETAIL
public static final java.lang.String fromField_MODULATIONTYPEDETAILfromField ROUTE name for SFInt32 field named modulationTypeDetail.- See Also:
- Constant Field Values
-
toField_MODULATIONTYPEDETAIL
public static final java.lang.String toField_MODULATIONTYPEDETAILtoField ROUTE name for SFInt32 field named modulationTypeDetail.- See Also:
- Constant Field Values
-
fromField_MODULATIONTYPEMAJOR
public static final java.lang.String fromField_MODULATIONTYPEMAJORfromField ROUTE name for SFInt32 field named modulationTypeMajor.- See Also:
- Constant Field Values
-
toField_MODULATIONTYPEMAJOR
public static final java.lang.String toField_MODULATIONTYPEMAJORtoField ROUTE name for SFInt32 field named modulationTypeMajor.- See Also:
- Constant Field Values
-
fromField_MODULATIONTYPESPREADSPECTRUM
public static final java.lang.String fromField_MODULATIONTYPESPREADSPECTRUMfromField ROUTE name for SFInt32 field named modulationTypeSpreadSpectrum.- See Also:
- Constant Field Values
-
toField_MODULATIONTYPESPREADSPECTRUM
public static final java.lang.String toField_MODULATIONTYPESPREADSPECTRUMtoField ROUTE name for SFInt32 field named modulationTypeSpreadSpectrum.- See Also:
- Constant Field Values
-
fromField_MODULATIONTYPESYSTEM
public static final java.lang.String fromField_MODULATIONTYPESYSTEMfromField ROUTE name for SFInt32 field named modulationTypeSystem.- See Also:
- Constant Field Values
-
toField_MODULATIONTYPESYSTEM
public static final java.lang.String toField_MODULATIONTYPESYSTEMtoField ROUTE name for SFInt32 field named modulationTypeSystem.- See Also:
- Constant Field Values
-
fromField_MULTICASTRELAYHOST
public static final java.lang.String fromField_MULTICASTRELAYHOSTfromField ROUTE name for SFString field named multicastRelayHost.- See Also:
- Constant Field Values
-
toField_MULTICASTRELAYHOST
public static final java.lang.String toField_MULTICASTRELAYHOSTtoField ROUTE name for SFString field named multicastRelayHost.- See Also:
- Constant Field Values
-
fromField_MULTICASTRELAYPORT
public static final java.lang.String fromField_MULTICASTRELAYPORTfromField ROUTE name for SFInt32 field named multicastRelayPort.- See Also:
- Constant Field Values
-
toField_MULTICASTRELAYPORT
public static final java.lang.String toField_MULTICASTRELAYPORTtoField ROUTE name for SFInt32 field named multicastRelayPort.- See Also:
- Constant Field Values
-
fromField_NETWORKMODE
public static final java.lang.String fromField_NETWORKMODEfromField ROUTE name for SFString field named networkMode.- See Also:
- Constant Field Values
-
toField_NETWORKMODE
public static final java.lang.String toField_NETWORKMODEtoField ROUTE name for SFString field named networkMode.- See Also:
- Constant Field Values
-
fromField_PORT
public static final java.lang.String fromField_PORTfromField ROUTE name for SFInt32 field named port.- See Also:
- Constant Field Values
-
toField_PORT
public static final java.lang.String toField_PORTtoField ROUTE name for SFInt32 field named port.- See Also:
- Constant Field Values
-
fromField_POWER
public static final java.lang.String fromField_POWERfromField ROUTE name for SFFloat field named power.- See Also:
- Constant Field Values
-
toField_POWER
public static final java.lang.String toField_POWERtoField ROUTE name for SFFloat field named power.- See Also:
- Constant Field Values
-
fromField_RADIOENTITYTYPECATEGORY
public static final java.lang.String fromField_RADIOENTITYTYPECATEGORYfromField ROUTE name for SFInt32 field named radioEntityTypeCategory.- See Also:
- Constant Field Values
-
toField_RADIOENTITYTYPECATEGORY
public static final java.lang.String toField_RADIOENTITYTYPECATEGORYtoField ROUTE name for SFInt32 field named radioEntityTypeCategory.- See Also:
- Constant Field Values
-
fromField_RADIOENTITYTYPECOUNTRY
public static final java.lang.String fromField_RADIOENTITYTYPECOUNTRYfromField ROUTE name for SFInt32 field named radioEntityTypeCountry.- See Also:
- Constant Field Values
-
toField_RADIOENTITYTYPECOUNTRY
public static final java.lang.String toField_RADIOENTITYTYPECOUNTRYtoField ROUTE name for SFInt32 field named radioEntityTypeCountry.- See Also:
- Constant Field Values
-
fromField_RADIOENTITYTYPEDOMAIN
public static final java.lang.String fromField_RADIOENTITYTYPEDOMAINfromField ROUTE name for SFInt32 field named radioEntityTypeDomain.- See Also:
- Constant Field Values
-
toField_RADIOENTITYTYPEDOMAIN
public static final java.lang.String toField_RADIOENTITYTYPEDOMAINtoField ROUTE name for SFInt32 field named radioEntityTypeDomain.- See Also:
- Constant Field Values
-
fromField_RADIOENTITYTYPEKIND
public static final java.lang.String fromField_RADIOENTITYTYPEKINDfromField ROUTE name for SFInt32 field named radioEntityTypeKind.- See Also:
- Constant Field Values
-
toField_RADIOENTITYTYPEKIND
public static final java.lang.String toField_RADIOENTITYTYPEKINDtoField ROUTE name for SFInt32 field named radioEntityTypeKind.- See Also:
- Constant Field Values
-
fromField_RADIOENTITYTYPENOMENCLATURE
public static final java.lang.String fromField_RADIOENTITYTYPENOMENCLATUREfromField ROUTE name for SFInt32 field named radioEntityTypeNomenclature.- See Also:
- Constant Field Values
-
toField_RADIOENTITYTYPENOMENCLATURE
public static final java.lang.String toField_RADIOENTITYTYPENOMENCLATUREtoField ROUTE name for SFInt32 field named radioEntityTypeNomenclature.- See Also:
- Constant Field Values
-
fromField_RADIOENTITYTYPENOMENCLATUREVERSION
public static final java.lang.String fromField_RADIOENTITYTYPENOMENCLATUREVERSIONfromField ROUTE name for SFInt32 field named radioEntityTypeNomenclatureVersion.- See Also:
- Constant Field Values
-
toField_RADIOENTITYTYPENOMENCLATUREVERSION
public static final java.lang.String toField_RADIOENTITYTYPENOMENCLATUREVERSIONtoField ROUTE name for SFInt32 field named radioEntityTypeNomenclatureVersion.- See Also:
- Constant Field Values
-
fromField_RADIOID
public static final java.lang.String fromField_RADIOIDfromField ROUTE name for SFInt32 field named radioID.- See Also:
- Constant Field Values
-
toField_RADIOID
public static final java.lang.String toField_RADIOIDtoField ROUTE name for SFInt32 field named radioID.- See Also:
- Constant Field Values
-
fromField_READINTERVAL
public static final java.lang.String fromField_READINTERVALfromField ROUTE name for SFTime field named readInterval.- See Also:
- Constant Field Values
-
toField_READINTERVAL
public static final java.lang.String toField_READINTERVALtoField ROUTE name for SFTime field named readInterval.- See Also:
- Constant Field Values
-
fromField_RELATIVEANTENNALOCATION
public static final java.lang.String fromField_RELATIVEANTENNALOCATIONfromField ROUTE name for SFVec3f field named relativeAntennaLocation.- See Also:
- Constant Field Values
-
toField_RELATIVEANTENNALOCATION
public static final java.lang.String toField_RELATIVEANTENNALOCATIONtoField ROUTE name for SFVec3f field named relativeAntennaLocation.- See Also:
- Constant Field Values
-
fromField_SITEID
public static final java.lang.String fromField_SITEIDfromField ROUTE name for SFInt32 field named siteID.- See Also:
- Constant Field Values
-
toField_SITEID
public static final java.lang.String toField_SITEIDtoField ROUTE name for SFInt32 field named siteID.- See Also:
- Constant Field Values
-
fromField_TIMESTAMP
public static final java.lang.String fromField_TIMESTAMPfromField ROUTE name for SFTime field named timestamp.- See Also:
- Constant Field Values
-
fromField_TRANSMITFREQUENCYBANDWIDTH
public static final java.lang.String fromField_TRANSMITFREQUENCYBANDWIDTHfromField ROUTE name for SFFloat field named transmitFrequencyBandwidth.- See Also:
- Constant Field Values
-
toField_TRANSMITFREQUENCYBANDWIDTH
public static final java.lang.String toField_TRANSMITFREQUENCYBANDWIDTHtoField ROUTE name for SFFloat field named transmitFrequencyBandwidth.- See Also:
- Constant Field Values
-
fromField_TRANSMITSTATE
public static final java.lang.String fromField_TRANSMITSTATEfromField ROUTE name for SFInt32 field named transmitState.- See Also:
- Constant Field Values
-
toField_TRANSMITSTATE
public static final java.lang.String toField_TRANSMITSTATEtoField ROUTE name for SFInt32 field named transmitState.- See Also:
- Constant Field Values
-
fromField_VISIBLE
public static final java.lang.String fromField_VISIBLEfromField ROUTE name for SFBool field named visible.- See Also:
- Constant Field Values
-
toField_VISIBLE
public static final java.lang.String toField_VISIBLEtoField ROUTE name for SFBool field named visible.- See Also:
- Constant Field Values
-
fromField_WHICHGEOMETRY
public static final java.lang.String fromField_WHICHGEOMETRYfromField ROUTE name for SFInt32 field named whichGeometry.- See Also:
- Constant Field Values
-
toField_WHICHGEOMETRY
public static final java.lang.String toField_WHICHGEOMETRYtoField ROUTE name for SFInt32 field named whichGeometry.- See Also:
- Constant Field Values
-
fromField_WRITEINTERVAL
public static final java.lang.String fromField_WRITEINTERVALfromField ROUTE name for SFTime field named writeInterval.- See Also:
- Constant Field Values
-
toField_WRITEINTERVAL
public static final java.lang.String toField_WRITEINTERVALtoField ROUTE name for SFTime field named writeInterval.- See Also:
- Constant Field Values
-
-
Constructor Details
-
TransmitterPduObject
public TransmitterPduObject()Constructor for TransmitterPduObject to initialize member variables with default values. -
TransmitterPduObject
public TransmitterPduObject(java.lang.String DEFlabel)Utility constructor that assigns DEF label after initializing member variables with default values.- Parameters:
DEFlabel
- unique DEF name for this X3D node
-
-
Method Details
-
getElementName
public final java.lang.String getElementName()Provides name of this element: TransmitterPdu- Specified by:
getElementName
in classX3DConcreteElement
- Returns:
- name of this element
-
getComponent
public final java.lang.String getComponent()Defines X3D component for the TransmitterPdu element: DIS- Specified by:
getComponent
in classX3DConcreteElement
- Returns:
- X3D component for this element
-
getComponentLevel
public final int getComponentLevel()Provides default X3D component level for this element: 1- Specified by:
getComponentLevel
in classX3DConcreteElement
- Returns:
- default X3D component level for this element
-
getFieldType
public java.lang.String getFieldType(java.lang.String fieldName)Indicate type corresponding to given fieldName.- Specified by:
getFieldType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D type (SFvec3f etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_TYPE
-
getAccessType
public java.lang.String getAccessType(java.lang.String fieldName)Indicate accessType corresponding to given fieldName.- Specified by:
getAccessType
in classX3DConcreteElement
- Parameters:
fieldName
- name of field in this X3D node- Returns:
- X3D accessType (inputOnly etc.), otherwise ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE if not recognized
- See Also:
ConfigurationProperties.ERROR_UNKNOWN_FIELD_ACCESSTYPE
-
getContainerFieldDefault
public final java.lang.String getContainerFieldDefault()containerField describes typical field relationship of a node to its parent. Usage is not ordinarily needed when using this API, default value is provided for informational purposes.- Specified by:
getContainerFieldDefault
in classX3DConcreteNode
- Returns:
- default containerField value
- See Also:
- X3D Scene Authoring Hints: containerField, X3D Unified Object Model (X3DUOM)
-
initialize
public final void initialize()Initialize all member variables to default values.- Overrides:
initialize
in classX3DConcreteNode
-
getAddress
public java.lang.String getAddress()Provide String value from inputOutput SFString field named address.
Tooltip: Multicast network address, or else "localhost" example: 224.2.181.145. *- Specified by:
getAddress
in interfaceTransmitterPdu
- Returns:
- value of address field
-
setAddress
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 interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the address field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAddress
Assign typed object value to SFString address field, similar tosetAddress(String)
.- Parameters:
newValue
- is new value for the address field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getAntennaLocation
public float[] getAntennaLocation()Provide array of 3-tuple float results from inputOutput SFVec3f field named antennaLocation.
Tooltip: World coordinates for antenna location. *- Specified by:
getAntennaLocation
in interfaceTransmitterPdu
- Returns:
- value of antennaLocation field
-
setAntennaLocation
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named antennaLocation.
Tooltip: World coordinates for antenna location. *- Specified by:
setAntennaLocation
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the antennaLocation field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAntennaLocation
Assign typed object value to SFVec3f antennaLocation field, similar tosetAntennaLocation(float[])
.- Parameters:
newValue
- is new value for the antennaLocation field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAntennaLocation
Assign values to SFVec3f antennaLocation field, similar tosetAntennaLocation(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAntennaLocation
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetAntennaLocation(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAntennaLocation
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetAntennaLocation(float[])
.- Parameters:
newArray
- is new value for field- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getAntennaPatternLength
public int getAntennaPatternLength()Provide int value from inputOutput SFInt32 field named antennaPatternLength.
Tooltip: . *- Specified by:
getAntennaPatternLength
in interfaceTransmitterPdu
- Returns:
- value of antennaPatternLength field
-
setAntennaPatternLength
Accessor method to assign int value to inputOutput SFInt32 field named antennaPatternLength.
Tooltip: . *- Specified by:
setAntennaPatternLength
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the antennaPatternLength field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAntennaPatternLength
Assign typed object value to SFInt32 antennaPatternLength field, similar tosetAntennaPatternLength(int)
.- Parameters:
newValue
- is new value for the antennaPatternLength field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getAntennaPatternType
public int getAntennaPatternType()Provide int value from inputOutput SFInt32 field named antennaPatternType.
Tooltip: Antenna shape pattern: 0 for omnidirectional, 1 for beam, 2 for spherical harmonic (deprecated), or optional higher value. *- Specified by:
getAntennaPatternType
in interfaceTransmitterPdu
- Returns:
- value of antennaPatternType field
-
setAntennaPatternType
Accessor method to assign int value to inputOutput SFInt32 field named antennaPatternType.
Tooltip: Antenna shape pattern: 0 for omnidirectional, 1 for beam, 2 for spherical harmonic (deprecated), or optional higher value. *- Specified by:
setAntennaPatternType
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the antennaPatternType field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setAntennaPatternType
Assign typed object value to SFInt32 antennaPatternType field, similar tosetAntennaPatternType(int)
.- Parameters:
newValue
- is new value for the antennaPatternType field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getApplicationID
public int getApplicationID()Provide int value from inputOutput SFInt32 field named applicationID.
Tooltip: Each simulation application that can respond to simulation management PDUs needs to have a unique applicationID. *- Specified by:
getApplicationID
in interfaceTransmitterPdu
- Returns:
- value of applicationID field
-
setApplicationID
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 interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the applicationID field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setApplicationID
Assign typed object value to SFInt32 applicationID field, similar tosetApplicationID(int)
.- Parameters:
newValue
- is new value for the applicationID field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBboxCenter
public float[] getBboxCenter()Provide array of 3-tuple float results from initializeOnly SFVec3f field named bboxCenter.
Tooltip: Bounding box center accompanies bboxSize and provides an optional hint for bounding box position offset from origin of local coordinate system.- 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/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
getBboxCenter
in interfaceTransmitterPdu
- Specified by:
getBboxCenter
in interfaceX3DBoundedObject
- Returns:
- value of bboxCenter field
-
setBboxCenter
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/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
setBboxCenter
in interfaceTransmitterPdu
- Specified by:
setBboxCenter
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the bboxCenter field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Assign typed object value to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.- Parameters:
newValue
- is new value for the bboxCenter field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Assign values to SFVec3f bboxCenter field, similar tosetBboxCenter(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxCenter
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxCenter(float[])
.- Parameters:
newArray
- is new value for field- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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 interfaceTransmitterPdu
- Specified by:
getBboxDisplay
in interfaceX3DBoundedObject
- Returns:
- value of bboxDisplay field
-
setBboxDisplay
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 interfaceTransmitterPdu
- Specified by:
setBboxDisplay
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the bboxDisplay field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxDisplay
Assign typed object value to SFBool bboxDisplay field, similar tosetBboxDisplay(boolean)
.- Parameters:
newValue
- is new value for the bboxDisplay field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getBboxSize
public float[] getBboxSize()Provide array of 3-tuple float results within allowed range of [0,infinity), or default value [-1 -1 -1], from initializeOnly SFVec3f field named bboxSize.
Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.- 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/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
getBboxSize
in interfaceTransmitterPdu
- Specified by:
getBboxSize
in interfaceX3DBoundedObject
- Returns:
- value of bboxSize field
-
setBboxSize
Accessor method to assign 3-tuple float array to initializeOnly SFVec3f field named bboxSize.
Tooltip: Bounding box size is usually omitted, and can easily be calculated automatically by an X3D player at scene-loading time with minimal computational cost. Bounding box size can also be defined as an optional authoring hint that suggests an optimization or constraint.- 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/documents/specifications/19775-1/V3.3/Part01/components/group.html#BoundingBoxes
- Hint: X3D Architecture, 10.3.1 X3DBoundedObject https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/group.html#X3DBoundedObject
- Specified by:
setBboxSize
in interfaceTransmitterPdu
- Specified by:
setBboxSize
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the bboxSize field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Assign typed object value to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.- Parameters:
newValue
- is new value for the bboxSize field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Assign values to SFVec3f bboxSize field, similar tosetBboxSize(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetBboxSize(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setBboxSize
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetBboxSize(float[])
.- Parameters:
newArray
- is new value for field- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCryptoKeyID
public int getCryptoKeyID()Provide int value from inputOutput SFInt32 field named cryptoKeyID.
Tooltip: Nonzero value corresponding to the simulated cryptographic key. Enumerations value 0 indicates plain (unencrypted) communications. *- Specified by:
getCryptoKeyID
in interfaceTransmitterPdu
- Returns:
- value of cryptoKeyID field
-
setCryptoKeyID
Accessor method to assign int value to inputOutput SFInt32 field named cryptoKeyID.
Tooltip: Nonzero value corresponding to the simulated cryptographic key. Enumerations value 0 indicates plain (unencrypted) communications. *- Specified by:
setCryptoKeyID
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the cryptoKeyID field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCryptoKeyID
Assign typed object value to SFInt32 cryptoKeyID field, similar tosetCryptoKeyID(int)
.- Parameters:
newValue
- is new value for the cryptoKeyID field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCryptoSystem
public int getCryptoSystem()Provide int value from inputOutput SFInt32 field named cryptoSystem.
Tooltip: Indicates type of crypto system being used, even if the encryption equipment is not keyed. Value 0 for No Encryption Device, higher enumerations values correspond to other specific equipment.. *- Specified by:
getCryptoSystem
in interfaceTransmitterPdu
- Returns:
- value of cryptoSystem field
-
setCryptoSystem
Accessor method to assign int value to inputOutput SFInt32 field named cryptoSystem.
Tooltip: Indicates type of crypto system being used, even if the encryption equipment is not keyed. Value 0 for No Encryption Device, higher enumerations values correspond to other specific equipment.. *- Specified by:
setCryptoSystem
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the cryptoSystem field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setCryptoSystem
Assign typed object value to SFInt32 cryptoSystem field, similar tosetCryptoSystem(int)
.- Parameters:
newValue
- is new value for the cryptoSystem field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getEnabled
public boolean getEnabled()Provide boolean value from inputOutput SFBool field named enabled.
Tooltip: Enables/disables the sensor node. *- Specified by:
getEnabled
in interfaceTransmitterPdu
- Specified by:
getEnabled
in interfaceX3DNetworkSensorNode
- Specified by:
getEnabled
in interfaceX3DSensorNode
- Returns:
- value of enabled field
-
setEnabled
Accessor method to assign boolean value to inputOutput SFBool field named enabled.
Tooltip: Enables/disables the sensor node. *- Specified by:
setEnabled
in interfaceTransmitterPdu
- Specified by:
setEnabled
in interfaceX3DNetworkSensorNode
- Specified by:
setEnabled
in interfaceX3DSensorNode
- Parameters:
newValue
- is new value for the enabled field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setEnabled
Assign typed object value to SFBool enabled field, similar tosetEnabled(boolean)
.- Parameters:
newValue
- is new value for the enabled field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getEntityID
public int getEntityID()Provide int value from inputOutput SFInt32 field named entityID.
Tooltip: EntityID unique ID for entity within that application. *- Specified by:
getEntityID
in interfaceTransmitterPdu
- Returns:
- value of entityID field
-
setEntityID
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 interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the entityID field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setEntityID
Assign typed object value to SFInt32 entityID field, similar tosetEntityID(int)
.- Parameters:
newValue
- is new value for the entityID field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getFrequency
public int getFrequency()Provide int value from inputOutput SFInt32 field named frequency.
Tooltip: Transmission frequency in Hz. If the radio is in frequency hopping mode, this field may be set to the center of the frequency hopping band currently in use, or to some other appropriate value. *- Specified by:
getFrequency
in interfaceTransmitterPdu
- Returns:
- value of frequency field
-
setFrequency
Accessor method to assign int value to inputOutput SFInt32 field named frequency.
Tooltip: Transmission frequency in Hz. If the radio is in frequency hopping mode, this field may be set to the center of the frequency hopping band currently in use, or to some other appropriate value. *- Specified by:
setFrequency
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the frequency field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setFrequency
Assign typed object value to SFInt32 frequency field, similar tosetFrequency(int)
.- Parameters:
newValue
- is new value for the frequency field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getGeoCoords
public double[] getGeoCoords()Provide array of 3-tuple double results from inputOutput SFVec3d field named geoCoords.
Tooltip: Geographic location (specified in current geoSystem coordinates) for children geometry (specified in relative coordinate system, in meters).- Hint: X3D for Advanced Modeling (X3D4AM) slideset http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
- Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>
- Specified by:
getGeoCoords
in interfaceTransmitterPdu
- Returns:
- value of geoCoords field
-
setGeoCoords
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 http://x3dgraphics.com/slidesets/X3dForAdvancedModeling/GeospatialComponentX3dEarth.pdf
- Warning: requires X3D profile='Full' or else include <component name='Geospatial' level='1'/>
- Specified by:
setGeoCoords
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the geoCoords field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGeoCoords
Assign typed object value to SFVec3d geoCoords field, similar tosetGeoCoords(double[])
.- Parameters:
newValue
- is new value for the geoCoords field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGeoCoords
Assign values to SFVec3d geoCoords field, similar tosetGeoCoords(double[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getGeoSystem
public java.lang.String[] getGeoSystem()Provide array of String results from initializeOnly MFString field named geoSystem.
Tooltip: Identifies spatial reference frame: Geodetic (GD), Geocentric (GC), Universal Transverse Mercator (UTM). Supported values: "GD" "UTM" or "GC" followed by additional quoted string parameters as appropriate for the type.- Hint: X3D Architecture 25.2.2 Spatial reference frames https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#Spatialreferenceframes
- Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.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 interfaceTransmitterPdu
- Returns:
- value of geoSystem field
-
getGeoSystemList
public java.util.ArrayList<java.lang.String> getGeoSystemList()Utility method to get ArrayList value of MFString geoSystem field, similar togetGeoSystem()
.- Returns:
- value of geoSystem field
-
getGeoSystemString
public java.lang.String getGeoSystemString()Utility method to get String value of MFString geoSystem field, similar togetGeoSystem()
.- Returns:
- value of geoSystem field
-
setGeoSystem
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/documents/specifications/19775-1/V3.3/Part01/components/geodata.html#Spatialreferenceframes
- Hint: X3D Architecture 25.2.4 Specifying geospatial coordinates https://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geodata.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 interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the geoSystem field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGeoSystem
Assign typed object value to MFString geoSystem field, similar tosetGeoSystem(String[])
.- Parameters:
newValue
- is new value for the geoSystem field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGeoSystem
Assign single SFString object value to MFString geoSystem field, similar tosetGeoSystem(String[])
.- Parameters:
newValue
- is new value for the geoSystem field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGeoSystem
Assign singleton String value to MFString geoSystem field, similar tosetGeoSystem(String[])
.- Parameters:
newValue
- is new value for the geoSystem field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setGeoSystem
Assign ArrayList value of MFString geoSystem field, similar tosetGeoSystem(String[])
.- Parameters:
newValue
- is new value for the geoSystem field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
clearGeoSystem
Utility method to clear MFString value of geoSystem field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addGeoSystem
Add singleton String value to MFString geoSystem field.- Parameters:
newValue
- is new value to add to the geoSystem field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
addGeoSystem
Add singleton SFStringObject value to MFString geoSystem field.- Parameters:
newValue
- is new value to add to the geoSystem field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
MFStringObject.cleanupEnumerationValues(String)
-
getInputSource
public int getInputSource()Provide int value from inputOutput SFInt32 field named inputSource.
Tooltip: Source of transmission input. Enumerations value 0 for Other, 1 for Pilot, 2 for Copilot, 3 for First Officer, 4 for Driver, 5 for Loader, 6 for Gunner, 7 for Commander, 8 for Digital Data Device, 9 for Intercom, 10 for Audio Jammer, 11 for Data Jammer, 12 for GPS Jammer, 13 for GPS Meaconer (masking beacon). *- Specified by:
getInputSource
in interfaceTransmitterPdu
- Returns:
- value of inputSource field
-
setInputSource
Accessor method to assign int value to inputOutput SFInt32 field named inputSource.
Tooltip: Source of transmission input. Enumerations value 0 for Other, 1 for Pilot, 2 for Copilot, 3 for First Officer, 4 for Driver, 5 for Loader, 6 for Gunner, 7 for Commander, 8 for Digital Data Device, 9 for Intercom, 10 for Audio Jammer, 11 for Data Jammer, 12 for GPS Jammer, 13 for GPS Meaconer (masking beacon). *- Specified by:
setInputSource
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the inputSource field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setInputSource
Assign typed object value to SFInt32 inputSource field, similar tosetInputSource(int)
.- Parameters:
newValue
- is new value for the inputSource field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIS
Provide ISObject instance (using a properly typed node) from inputOutput SFNode field IS.- Specified by:
getIS
in classX3DConcreteNode
- Returns:
- value of IS field
- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
setIS
Accessor method to assign ISObject instance (using a properly typed node) to inputOutput SFNode field IS.- Specified by:
setIS
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the IS field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- X3D Tooltips: IS, X3D Tooltips: connect
-
clearIS
Utility method to clear SFNode value of IS field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
hasIS
public boolean hasIS()Indicate whether an object is available for inputOutput SFNode field IS.- Returns:
- whether a concrete statement or CommentsBlock is available.
- See Also:
getIS()
-
getIsActive
public boolean getIsActive()Provide boolean value from outputOnly SFBool field named isActive.
Tooltip: Have we had a network update recently?.- Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
- Specified by:
getIsActive
in interfaceTransmitterPdu
- Specified by:
getIsActive
in interfaceX3DNetworkSensorNode
- Specified by:
getIsActive
in interfaceX3DSensorNode
- 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 interfaceTransmitterPdu
- 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 interfaceTransmitterPdu
- 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 interfaceTransmitterPdu
- 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 interfaceTransmitterPdu
- Returns:
- value of isStandAlone field
-
getLengthOfModulationParameters
public int getLengthOfModulationParameters()Provide int value from inputOutput SFInt32 field named lengthOfModulationParameters.
Tooltip: . *- Specified by:
getLengthOfModulationParameters
in interfaceTransmitterPdu
- Returns:
- value of lengthOfModulationParameters field
-
setLengthOfModulationParameters
Accessor method to assign int value to inputOutput SFInt32 field named lengthOfModulationParameters.
Tooltip: . *- Specified by:
setLengthOfModulationParameters
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the lengthOfModulationParameters field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setLengthOfModulationParameters
Assign typed object value to SFInt32 lengthOfModulationParameters field, similar tosetLengthOfModulationParameters(int)
.- Parameters:
newValue
- is new value for the lengthOfModulationParameters field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
Provide X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.- Specified by:
getMetadata
in interfaceTransmitterPdu
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DNetworkSensorNode
- Specified by:
getMetadata
in interfaceX3DNode
- Specified by:
getMetadata
in interfaceX3DSensorNode
- 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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
setMetadata
Accessor method to assign X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in interfaceTransmitterPdu
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DNetworkSensorNode
- Specified by:
setMetadata
in interfaceX3DNode
- Specified by:
setMetadata
in interfaceX3DSensorNode
- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
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/documents/specifications/19775-1/V3.3/Part01/components/core.html#Metadata
, X3D Scene Authoring Hints: Metadata Nodes
-
clearMetadata
Utility method to clear SFNode value of metadata field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
setMetadata
Assign ProtoInstance (using a properly typed node) to inputOutput SFNode field metadata.- Specified by:
setMetadata
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
setMetadata(X3DMetadataObject)
-
hasMetadata
public boolean hasMetadata()Indicate whether an object is available for inputOutput SFNode field metadata.- Returns:
- whether a properly typed node or ProtoInstance or CommentsBlock is available.
- See Also:
getMetadata()
,getMetadataProtoInstance()
, X3D Scene Authoring Hints: Metadata Nodes
-
getModulationTypeDetail
public int getModulationTypeDetail()Provide int value from inputOutput SFInt32 field named modulationTypeDetail.
Tooltip: Integer enumeration containing detailed information depending on the major modulation type. *- Specified by:
getModulationTypeDetail
in interfaceTransmitterPdu
- Returns:
- value of modulationTypeDetail field
-
setModulationTypeDetail
Accessor method to assign int value to inputOutput SFInt32 field named modulationTypeDetail.
Tooltip: Integer enumeration containing detailed information depending on the major modulation type. *- Specified by:
setModulationTypeDetail
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the modulationTypeDetail field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setModulationTypeDetail
Assign typed object value to SFInt32 modulationTypeDetail field, similar tosetModulationTypeDetail(int)
.- Parameters:
newValue
- is new value for the modulationTypeDetail field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getModulationTypeMajor
public int getModulationTypeMajor()Provide int value from inputOutput SFInt32 field named modulationTypeMajor.
Tooltip: Integer enumeration containing major classification of the modulation type. Enumerations value 0 for No Statement, 1 for Amplitude, 2 for Amplitude and Angle, 3 for Angle, 4 for Combination, 5 for Pulse, 6 for Unmodulated, 7 for Carrier Phase Shift Modulation (CPSM). *- Specified by:
getModulationTypeMajor
in interfaceTransmitterPdu
- Returns:
- value of modulationTypeMajor field
-
setModulationTypeMajor
Accessor method to assign int value to inputOutput SFInt32 field named modulationTypeMajor.
Tooltip: Integer enumeration containing major classification of the modulation type. Enumerations value 0 for No Statement, 1 for Amplitude, 2 for Amplitude and Angle, 3 for Angle, 4 for Combination, 5 for Pulse, 6 for Unmodulated, 7 for Carrier Phase Shift Modulation (CPSM). *- Specified by:
setModulationTypeMajor
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the modulationTypeMajor field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setModulationTypeMajor
Assign typed object value to SFInt32 modulationTypeMajor field, similar tosetModulationTypeMajor(int)
.- Parameters:
newValue
- is new value for the modulationTypeMajor field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getModulationTypeSpreadSpectrum
public int getModulationTypeSpreadSpectrum()Provide int value from inputOutput SFInt32 field named modulationTypeSpreadSpectrum.
Tooltip: Indicates the spread spectrum technique or combination of spread spectrum techniques in use. *- Specified by:
getModulationTypeSpreadSpectrum
in interfaceTransmitterPdu
- Returns:
- value of modulationTypeSpreadSpectrum field
-
setModulationTypeSpreadSpectrum
Accessor method to assign int value to inputOutput SFInt32 field named modulationTypeSpreadSpectrum.
Tooltip: Indicates the spread spectrum technique or combination of spread spectrum techniques in use. *- Specified by:
setModulationTypeSpreadSpectrum
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the modulationTypeSpreadSpectrum field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setModulationTypeSpreadSpectrum
Assign typed object value to SFInt32 modulationTypeSpreadSpectrum field, similar tosetModulationTypeSpreadSpectrum(int)
.- Parameters:
newValue
- is new value for the modulationTypeSpreadSpectrum field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getModulationTypeSystem
public int getModulationTypeSystem()Provide int value from inputOutput SFInt32 field named modulationTypeSystem.
Tooltip: Specifies radio system associated with this Transmitter PDU and used to interpret other fields whose values depend on a specific radio system. *- Specified by:
getModulationTypeSystem
in interfaceTransmitterPdu
- Returns:
- value of modulationTypeSystem field
-
setModulationTypeSystem
Accessor method to assign int value to inputOutput SFInt32 field named modulationTypeSystem.
Tooltip: Specifies radio system associated with this Transmitter PDU and used to interpret other fields whose values depend on a specific radio system. *- Specified by:
setModulationTypeSystem
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the modulationTypeSystem field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setModulationTypeSystem
Assign typed object value to SFInt32 modulationTypeSystem field, similar tosetModulationTypeSystem(int)
.- Parameters:
newValue
- is new value for the modulationTypeSystem field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMulticastRelayHost
public java.lang.String getMulticastRelayHost()Provide String value from inputOutput SFString field named multicastRelayHost.
Tooltip: Fallback server address if multicast not available locally. For example: track.nps.edu. *- Specified by:
getMulticastRelayHost
in interfaceTransmitterPdu
- Returns:
- value of multicastRelayHost field
-
setMulticastRelayHost
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 interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the multicastRelayHost field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMulticastRelayHost
Assign typed object value to SFString multicastRelayHost field, similar tosetMulticastRelayHost(String)
.- Parameters:
newValue
- is new value for the multicastRelayHost field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMulticastRelayPort
public int getMulticastRelayPort()Provide int value from inputOutput SFInt32 field named multicastRelayPort.
Tooltip: Fallback server port if multicast not available locally. For example: 8010. *- Specified by:
getMulticastRelayPort
in interfaceTransmitterPdu
- Returns:
- value of multicastRelayPort field
-
setMulticastRelayPort
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 interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the multicastRelayPort field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setMulticastRelayPort
Assign typed object value to SFInt32 multicastRelayPort field, similar tosetMulticastRelayPort(int)
.- Parameters:
newValue
- is new value for the multicastRelayPort field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getNetworkMode
public java.lang.String getNetworkMode()Provide String enumeration value (baseType 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 interfaceTransmitterPdu
- Returns:
- value of networkMode field
-
setNetworkMode
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 interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the networkMode field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setNetworkMode
Assign typed object value to SFString networkMode field, similar tosetNetworkMode(String)
.- Parameters:
newValue
- is new value for the networkMode field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getPort
public int getPort()Provide int value from inputOutput SFInt32 field named port.
Tooltip: Multicast network port, for example: 3000. *- Specified by:
getPort
in interfaceTransmitterPdu
- Returns:
- value of port field
-
setPort
Accessor method to assign int value to inputOutput SFInt32 field named port.
Tooltip: Multicast network port, for example: 3000. *- Specified by:
setPort
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the port field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setPort
Assign typed object value to SFInt32 port field, similar tosetPort(int)
.- Parameters:
newValue
- is new value for the port field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getPower
public float getPower()Provide float value from inputOutput SFFloat field named power.
Tooltip: Power that radio would be capable of outputting if on and transmitting, independent of actual transmit state of the radio. *- Specified by:
getPower
in interfaceTransmitterPdu
- Returns:
- value of power field
-
setPower
Accessor method to assign float value to inputOutput SFFloat field named power.
Tooltip: Power that radio would be capable of outputting if on and transmitting, independent of actual transmit state of the radio. *- Specified by:
setPower
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the power field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setPower
Assign typed object value to SFFloat power field, similar tosetPower(float)
.- Parameters:
newValue
- is new value for the power field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setPower
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetPower(float)
.- Parameters:
newValue
- is new value for field- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getRadioEntityTypeCategory
public int getRadioEntityTypeCategory()Provide int value from inputOutput SFInt32 field named radioEntityTypeCategory.
Tooltip: Integer enumeration containing EntityType of transmitter radio. Enumerations value: 0 for Other, 1 for Generic Radio or Simple Intercom, 2 for HAVE QUICK, 3 for HAVE QUICK II, 4 for HAVE QUICK IIA, 5 for SINCGARS, 6 for CCTT SINCGARS, 7 for EPLRS (Enhanced Position Location Reporting System), 8 for JTIDS/MIDS, 9 for Link 11, 10 for Link 11B, 11 for L-Band SATCOM, 12 for Enhanced SINCGARS 7.3, 13 for Navigation Aid. *- Specified by:
getRadioEntityTypeCategory
in interfaceTransmitterPdu
- Returns:
- value of radioEntityTypeCategory field
-
setRadioEntityTypeCategory
Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeCategory.
Tooltip: Integer enumeration containing EntityType of transmitter radio. Enumerations value: 0 for Other, 1 for Generic Radio or Simple Intercom, 2 for HAVE QUICK, 3 for HAVE QUICK II, 4 for HAVE QUICK IIA, 5 for SINCGARS, 6 for CCTT SINCGARS, 7 for EPLRS (Enhanced Position Location Reporting System), 8 for JTIDS/MIDS, 9 for Link 11, 10 for Link 11B, 11 for L-Band SATCOM, 12 for Enhanced SINCGARS 7.3, 13 for Navigation Aid. *- Specified by:
setRadioEntityTypeCategory
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the radioEntityTypeCategory field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRadioEntityTypeCategory
Assign typed object value to SFInt32 radioEntityTypeCategory field, similar tosetRadioEntityTypeCategory(int)
.- Parameters:
newValue
- is new value for the radioEntityTypeCategory field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getRadioEntityTypeCountry
public int getRadioEntityTypeCountry()Provide int value from inputOutput SFInt32 field named radioEntityTypeCountry.
Tooltip: Integer enumerations value for country to which the design of the entity or its design specification is attributed. *- Specified by:
getRadioEntityTypeCountry
in interfaceTransmitterPdu
- Returns:
- value of radioEntityTypeCountry field
-
setRadioEntityTypeCountry
Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeCountry.
Tooltip: Integer enumerations value for country to which the design of the entity or its design specification is attributed. *- Specified by:
setRadioEntityTypeCountry
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the radioEntityTypeCountry field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRadioEntityTypeCountry
Assign typed object value to SFInt32 radioEntityTypeCountry field, similar tosetRadioEntityTypeCountry(int)
.- Parameters:
newValue
- is new value for the radioEntityTypeCountry field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getRadioEntityTypeDomain
public int getRadioEntityTypeDomain()Provide int value from inputOutput SFInt32 field named radioEntityTypeDomain.
Tooltip: Integer enumerations value for domain in which the entity operates: LAND, AIR, SURFACE, SUBSURFACE, SPACE or OTHER. *- Specified by:
getRadioEntityTypeDomain
in interfaceTransmitterPdu
- Returns:
- value of radioEntityTypeDomain field
-
setRadioEntityTypeDomain
Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeDomain.
Tooltip: Integer enumerations value for domain in which the entity operates: LAND, AIR, SURFACE, SUBSURFACE, SPACE or OTHER. *- Specified by:
setRadioEntityTypeDomain
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the radioEntityTypeDomain field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRadioEntityTypeDomain
Assign typed object value to SFInt32 radioEntityTypeDomain field, similar tosetRadioEntityTypeDomain(int)
.- Parameters:
newValue
- is new value for the radioEntityTypeDomain field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getRadioEntityTypeKind
public int getRadioEntityTypeKind()Provide int value from inputOutput SFInt32 field named radioEntityTypeKind.
Tooltip: Integer enumerations value for whether entity is a PLATFORM, MUNITION, LIFE_FORM, ENVIRONMENTAL, CULTURAL_FEATURE, SUPPLY, RADIO, EXPENDABLE, SENSOR_EMITTER or OTHER. *- Specified by:
getRadioEntityTypeKind
in interfaceTransmitterPdu
- Returns:
- value of radioEntityTypeKind field
-
setRadioEntityTypeKind
Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeKind.
Tooltip: Integer enumerations value for whether entity is a PLATFORM, MUNITION, LIFE_FORM, ENVIRONMENTAL, CULTURAL_FEATURE, SUPPLY, RADIO, EXPENDABLE, SENSOR_EMITTER or OTHER. *- Specified by:
setRadioEntityTypeKind
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the radioEntityTypeKind field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRadioEntityTypeKind
Assign typed object value to SFInt32 radioEntityTypeKind field, similar tosetRadioEntityTypeKind(int)
.- Parameters:
newValue
- is new value for the radioEntityTypeKind field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getRadioEntityTypeNomenclature
public int getRadioEntityTypeNomenclature()Provide int value from inputOutput SFInt32 field named radioEntityTypeNomenclature.
Tooltip: Integer enumerations value indicating nomenclature (name) for a particular emitter. See DIS enumerations reference for value/name pairs. *- Specified by:
getRadioEntityTypeNomenclature
in interfaceTransmitterPdu
- Returns:
- value of radioEntityTypeNomenclature field
-
setRadioEntityTypeNomenclature
Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeNomenclature.
Tooltip: Integer enumerations value indicating nomenclature (name) for a particular emitter. See DIS enumerations reference for value/name pairs. *- Specified by:
setRadioEntityTypeNomenclature
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the radioEntityTypeNomenclature field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRadioEntityTypeNomenclature
Assign typed object value to SFInt32 radioEntityTypeNomenclature field, similar tosetRadioEntityTypeNomenclature(int)
.- Parameters:
newValue
- is new value for the radioEntityTypeNomenclature field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getRadioEntityTypeNomenclatureVersion
public int getRadioEntityTypeNomenclatureVersion()Provide int value from inputOutput SFInt32 field named radioEntityTypeNomenclatureVersion.
Tooltip: Named equipment version number. *- Specified by:
getRadioEntityTypeNomenclatureVersion
in interfaceTransmitterPdu
- Returns:
- value of radioEntityTypeNomenclatureVersion field
-
setRadioEntityTypeNomenclatureVersion
Accessor method to assign int value to inputOutput SFInt32 field named radioEntityTypeNomenclatureVersion.
Tooltip: Named equipment version number. *- Specified by:
setRadioEntityTypeNomenclatureVersion
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the radioEntityTypeNomenclatureVersion field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRadioEntityTypeNomenclatureVersion
Assign typed object value to SFInt32 radioEntityTypeNomenclatureVersion field, similar tosetRadioEntityTypeNomenclatureVersion(int)
.- Parameters:
newValue
- is new value for the radioEntityTypeNomenclatureVersion field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getRadioID
public int getRadioID()Provide int value from inputOutput SFInt32 field named radioID.
Tooltip: Identifies a particular radio within a given entity. *- Specified by:
getRadioID
in interfaceTransmitterPdu
- Returns:
- value of radioID field
-
setRadioID
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 interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the radioID field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRadioID
Assign typed object value to SFInt32 radioID field, similar tosetRadioID(int)
.- Parameters:
newValue
- is new value for the radioID field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getReadInterval
public double getReadInterval()Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named readInterval.
Tooltip: [0,+infinity) Seconds between read updates, 0 means no reading.- Hint: readInterval is a nonnegative SFTime duration interval, not an absolute clock time.
- Specified by:
getReadInterval
in interfaceTransmitterPdu
- Returns:
- value of readInterval field
-
setReadInterval
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 interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the readInterval field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setReadInterval
Assign typed object value to SFTime readInterval field, similar tosetReadInterval(double)
.- Parameters:
newValue
- is new value for the readInterval field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getRelativeAntennaLocation
public float[] getRelativeAntennaLocation()Provide array of 3-tuple float results from inputOutput SFVec3f field named relativeAntennaLocation.
Tooltip: Relative coordinates for antenna location. *- Specified by:
getRelativeAntennaLocation
in interfaceTransmitterPdu
- Returns:
- value of relativeAntennaLocation field
-
setRelativeAntennaLocation
Accessor method to assign 3-tuple float array to inputOutput SFVec3f field named relativeAntennaLocation.
Tooltip: Relative coordinates for antenna location. *- Specified by:
setRelativeAntennaLocation
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the relativeAntennaLocation field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRelativeAntennaLocation
Assign typed object value to SFVec3f relativeAntennaLocation field, similar tosetRelativeAntennaLocation(float[])
.- Parameters:
newValue
- is new value for the relativeAntennaLocation field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRelativeAntennaLocation
Assign values to SFVec3f relativeAntennaLocation field, similar tosetRelativeAntennaLocation(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRelativeAntennaLocation
Utility method: double-precision set-parameters accessor for X3D floating-point type, similar tosetRelativeAntennaLocation(float[])
.- Parameters:
x
- first componenty
- second componentz
- third component- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRelativeAntennaLocation
Utility method: double-precision set-array accessor for X3D floating-point type, similar tosetRelativeAntennaLocation(float[])
.- Parameters:
newArray
- is new value for field- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getRtpHeaderExpected
public boolean getRtpHeaderExpected()Provide boolean value from initializeOnly SFBool field named rtpHeaderExpected.
Tooltip: Whether RTP headers are prepended to DIS PDUs. *- Specified by:
getRtpHeaderExpected
in interfaceTransmitterPdu
- Returns:
- value of rtpHeaderExpected field
-
setRtpHeaderExpected
Accessor method to assign boolean value to initializeOnly SFBool field named rtpHeaderExpected.
Tooltip: Whether RTP headers are prepended to DIS PDUs. *- Specified by:
setRtpHeaderExpected
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the rtpHeaderExpected field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setRtpHeaderExpected
Assign typed object value to SFBool rtpHeaderExpected field, similar tosetRtpHeaderExpected(boolean)
.- Parameters:
newValue
- is new value for the rtpHeaderExpected field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getSiteID
public int getSiteID()Provide int value from inputOutput SFInt32 field named siteID.
Tooltip: Simulation/exercise siteID of the participating LAN or organization. *- Specified by:
getSiteID
in interfaceTransmitterPdu
- Returns:
- value of siteID field
-
setSiteID
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 interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the siteID field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setSiteID
Assign typed object value to SFInt32 siteID field, similar tosetSiteID(int)
.- Parameters:
newValue
- is new value for the siteID field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getTimestamp
public double getTimestamp()Provide double value in seconds within allowed range of [0,infinity) from outputOnly SFTime field named timestamp.
Tooltip: DIS timestamp in X3D units (value 0.0 matches 1 January 1970) in seconds.- Warning: it is an error to define this transient outputOnly field in an X3D file, instead only use it a source for ROUTE events.
- Specified by:
getTimestamp
in interfaceTransmitterPdu
- Returns:
- value of timestamp field
-
getTransmitFrequencyBandwidth
public float getTransmitFrequencyBandwidth()Provide float value from inputOutput SFFloat field named transmitFrequencyBandwidth.
Tooltip: Bandwidth of the particular transmitter measured between the half-power (-3 dB) points (this value represents total bandwidth, not the deviation from the center frequency). *- Specified by:
getTransmitFrequencyBandwidth
in interfaceTransmitterPdu
- Returns:
- value of transmitFrequencyBandwidth field
-
setTransmitFrequencyBandwidth
Accessor method to assign float value to inputOutput SFFloat field named transmitFrequencyBandwidth.
Tooltip: Bandwidth of the particular transmitter measured between the half-power (-3 dB) points (this value represents total bandwidth, not the deviation from the center frequency). *- Specified by:
setTransmitFrequencyBandwidth
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the transmitFrequencyBandwidth field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTransmitFrequencyBandwidth
Assign typed object value to SFFloat transmitFrequencyBandwidth field, similar tosetTransmitFrequencyBandwidth(float)
.- Parameters:
newValue
- is new value for the transmitFrequencyBandwidth field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTransmitFrequencyBandwidth
Utility method: double-precision set-parameter accessor for X3D floating-point type, similar tosetTransmitFrequencyBandwidth(float)
.- Parameters:
newValue
- is new value for field- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getTransmitState
public int getTransmitState()Provide int value from inputOutput SFInt32 field named transmitState.
Tooltip: Specify radio transmission state where enumerations value 0 is for off, value 1 for powered but not transmitting, or value 1 is for powered and transmitting,. *- Specified by:
getTransmitState
in interfaceTransmitterPdu
- Returns:
- value of transmitState field
-
setTransmitState
Accessor method to assign int value to inputOutput SFInt32 field named transmitState.
Tooltip: Specify radio transmission state where enumerations value 0 is for off, value 1 for powered but not transmitting, or value 1 is for powered and transmitting,. *- Specified by:
setTransmitState
in interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the transmitState field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setTransmitState
Assign typed object value to SFInt32 transmitState field, similar tosetTransmitState(int)
.- Parameters:
newValue
- is new value for the transmitState field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
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 interfaceTransmitterPdu
- Specified by:
getVisible
in interfaceX3DBoundedObject
- Returns:
- value of visible field
-
setVisible
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 interfaceTransmitterPdu
- Specified by:
setVisible
in interfaceX3DBoundedObject
- Parameters:
newValue
- is new value for the visible field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setVisible
Assign typed object value to SFBool visible field, similar tosetVisible(boolean)
.- Parameters:
newValue
- is new value for the visible field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getWhichGeometry
public int getWhichGeometry()Provide int value from inputOutput SFInt32 field named whichGeometry.
Tooltip: Select geometry to render: -1 for no geometry, 0 for text trace, 1 for default geometry, (optional) higher values to render different states. *- Specified by:
getWhichGeometry
in interfaceTransmitterPdu
- Returns:
- value of whichGeometry field
-
setWhichGeometry
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 interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the whichGeometry field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setWhichGeometry
Assign typed object value to SFInt32 whichGeometry field, similar tosetWhichGeometry(int)
.- Parameters:
newValue
- is new value for the whichGeometry field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getWriteInterval
public double getWriteInterval()Provide double value in seconds within allowed range of [0,infinity) from inputOutput SFTime field named writeInterval.
Tooltip: [0,+infinity) Seconds between write updates, 0 means no writing (sending).- Hint: writeInterval is a nonnegative SFTime duration interval, not an absolute clock time.
- Specified by:
getWriteInterval
in interfaceTransmitterPdu
- Returns:
- value of writeInterval field
-
setWriteInterval
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 interfaceTransmitterPdu
- Parameters:
newValue
- is new value for the writeInterval field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setWriteInterval
Assign typed object value to SFTime writeInterval field, similar tosetWriteInterval(double)
.- Parameters:
newValue
- is new value for the writeInterval field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDEF
public java.lang.String getDEF()Provide String value from inputOutput SFString field named DEF.
Tooltip: DEF defines a unique ID name for this node, referenceable by other nodes.- 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 classX3DConcreteNode
- Returns:
- value of DEF field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setDEF
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the DEF field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setDEF
Assign typed object value to SFString DEF field, similar tosetDEF(String)
.- Parameters:
newValue
- is new value for the DEF field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getUSE
public java.lang.String getUSE()Provide String value from inputOutput SFString field named USE.
Tooltip: USE means reuse an already DEF-ed node ID, excluding all child nodes and all other attributes (except for containerField, which can have a different value).- Hint: USE references to previously defined DEF geometry (instead of duplicating nodes) can improve performance.
- Warning: do NOT include any child nodes, a DEF attribute, or any other attribute values (except for containerField) when defining a USE attribute.
- Warning: each USE value must match a corresponding DEF value that is defined earlier in the scene.
- Overrides:
getUSE
in classX3DConcreteNode
- Returns:
- value of USE field
- See Also:
- X3D Scene Authoring Hints: Naming Conventions
-
setUSE
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: eachUSE
node is still an independent object, with theUSE
value matching theDEF
value in the preceding object.
Warning: invoking thesetUSE()
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 classX3DConcreteNode
- Parameters:
newValue
- is new value for the USE field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign typed object value to SFString USE field, similar tosetUSE(String)
.- Parameters:
newValue
- is new value for the USE field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getCssClass
public java.lang.String getCssClass()Provide String value from inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Overrides:
getCssClass
in classX3DConcreteNode
- Returns:
- value of class field
- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Accessor method to assign String value to inputOutput SFString field named class.
Tooltip: The class attribute is a space-separated list of classes, reserved for use by CSS cascading stylesheets.- Warning: currently the class attribute is only supported in XML encoding of X3D scenes.
- Hint: W3C Cascading Style Sheets https://www.w3.org/Style/CSS
- Specified by:
setCssClass
in classX3DConcreteNode
- Parameters:
newValue
- is new value for the class field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
- W3C Cascading Style Sheets
-
setCssClass
Assign typed object value to SFString cssClass field, similar tosetCssClass(String)
.- Parameters:
newValue
- is new value for the class field.- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
setUSE
Assign a USE reference to another DEF node of same node type, similar tosetUSE(String)
.
Warning: note that thesetUSE()
method on this node resets all other fields to their default values (except for containerField) and also releases all child nodes.
Warning: no other operations can be performed to modify a USE node other than setting an alternate containerField value.- Parameters:
DEFnode
- must have a DEF value defined- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
addComments
Add comment as String to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComment
- initial value- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add comments as String[] array to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newComments
- array of comments- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
addComments
Add CommentsBlock to contained commentsList.- Specified by:
addComments
in classX3DConcreteElement
- Parameters:
newCommentsBlock
- block of comments to add- Returns:
TransmitterPduObject
- namely this same object to allow sequential method pipelining (i.e. consecutive setAttribute method invocations).
-
toStringX3D
public java.lang.String toStringX3D(int indentLevel)Recursive method to provide X3D string serialization of this model subgraph, utilizing XML encoding and conforming to X3D Canonical Form.- Specified by:
toStringX3D
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- X3D string
- See Also:
X3DObject.FILE_EXTENSION_X3D
,X3DObject.FILE_EXTENSION_XML
,X3DObject.toStringXML()
,X3DObject.toFileXML(String)
,X3DObject.toFileX3D(String)
, X3D XML Encoding, X3D Compressed Binary Encoding: X3D Canonical Form, X3D Canonicalization (C14N) Tool
-
toStringClassicVRML
public java.lang.String toStringClassicVRML(int indentLevel)Recursive method to provide ClassicVRML string serialization.- Specified by:
toStringClassicVRML
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- ClassicVRML string
- See Also:
X3DObject.FILE_EXTENSION_CLASSICVRML
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Extensible 3D (X3D) encodings Part 2: Classic VRML encoding, Annex A: Grammar
-
toStringVRML97
public java.lang.String toStringVRML97(int indentLevel)Recursive method to provide VRML97 string serialization.- Specified by:
toStringVRML97
in classX3DConcreteElement
- Parameters:
indentLevel
- number of levels of indentation for this element- Returns:
- VRML97 string
- See Also:
X3DObject.FILE_EXTENSION_VRML97
, X3D Resources: Virtual Reality Modeling Language (VRML) 97, Virtual Reality Modeling Language (VRML) 97 specification, VRML 97 v2.1 Amendment
-
findElementByNameValue
Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
findElementByNameValue
public X3DConcreteElement findElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to provide object reference to node or statement by name attribute, if found as part of this element or in a contained element. Elements with name fields include meta, Metadata* nodes, field/fieldValue, ProtoDeclare/ExternProtoDeclare/ProtoInstance, CAD and HAnim nodes.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same name, this method does not handle that case.- Specified by:
findElementByNameValue
in classX3DConcreteElement
- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- object reference to found element, null otherwise
- See Also:
findNodeByDEF(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasElementByNameValue
public boolean hasElementByNameValue(java.lang.String nameValue, java.lang.String elementName)Recursive method to determine whether node or statement with given name attribute is found, meaning both objects are attached to same scene graph.- Parameters:
nameValue
- is value of the name field being searched for in this element and child elements(if any)elementName
- identifies the element of interest (meta MetadataString ProtoDeclare CADassembly ProtoInstance HAnimHumanoid etc.)- Returns:
- whether node is found
- See Also:
findElementByNameValue(String, String)
-
findNodeByDEF
Recursive method to provide object reference to node by DEF, if found as this node or in a contained node.
Warning: first start with findAncestorSceneObject() to check entire scene graph, or findAncestorX3DObject() to check entire model document.
Warning: more than one element may be found that has the same DEF, this method does not handle that case.- Specified by:
findNodeByDEF
in classX3DConcreteElement
- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- object reference to found node, null otherwise
- See Also:
findElementByNameValue(String)
,X3DConcreteElement.hasAncestorSceneObject()
,X3DConcreteElement.findAncestorX3DObject()
-
hasNodeByDEF
public boolean hasNodeByDEF(java.lang.String DEFvalue)Recursive method to determine whether node with DEFvalue is found, meaning both objects are attached to same scene graph.- Parameters:
DEFvalue
- is value of the name field being searched for in this element and child elements(if any)- Returns:
- whether node is found
- See Also:
findNodeByDEF(String)
-
validate
public java.lang.String validate()Recursive method to validate this element plus all contained nodes and statements, using both datatype-specification value checks and regular expression (regex) checking of corresponding string values.- Specified by:
validate
in classX3DConcreteElement
- Returns:
- validation results (if any)
-