X3D libraries
The libraries to work with X3D dataset

x3d::EspduTransform Class Reference

EspduTransform class definition automatically generated by html-to-header v1.0. More...

#include <objects.h>

Inheritance diagram for x3d::EspduTransform:

Inheritance graph
[legend]
Collaboration diagram for x3d::EspduTransform:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 EspduTransform ()
virtual bool FieldHasDefaultValue (field_t name) const
 Test to know whether a field is currently set to its default value.
SFStringget_address () const
SFInt32 get_applicationID () const
MFFloatget_articulationParameterArray () const
MFInt32get_articulationParameterChangeIndicatorArray () const
SFInt32 get_articulationParameterCount () const
MFInt32get_articulationParameterDesignatorArray () const
MFInt32get_articulationParameterIdPartAttachedToArray () const
MFInt32get_articulationParameterTypeArray () const
SFFloat get_articulationParameterValue0_changed () const
SFFloat get_articulationParameterValue1_changed () const
SFFloat get_articulationParameterValue2_changed () const
SFFloat get_articulationParameterValue3_changed () const
SFFloat get_articulationParameterValue4_changed () const
SFFloat get_articulationParameterValue5_changed () const
SFFloat get_articulationParameterValue6_changed () const
SFFloat get_articulationParameterValue7_changed () const
SFVec3fget_center () const
SFTime get_collideTime () const
SFInt32 get_collisionType () const
SFInt32 get_deadReckoning () const
SFTime get_detonateTime () const
SFVec3fget_detonationLocation () const
SFVec3fget_detonationRelativeLocation () const
SFInt32 get_detonationResult () const
SFInt32 get_entityCategory () const
SFInt32 get_entityCountry () const
SFInt32 get_entityDomain () const
SFInt32 get_entityExtra () const
SFInt32 get_entityID () const
SFInt32 get_entityKind () const
SFInt32 get_entitySpecific () const
SFInt32 get_entitySubCategory () const
SFInt32 get_eventApplicationID () const
SFInt32 get_eventEntityID () const
SFInt32 get_eventNumber () const
SFInt32 get_eventSiteID () const
SFBool get_fired1 () const
SFBool get_fired2 () const
SFTime get_firedTime () const
SFInt32 get_fireMissionIndex () const
SFFloat get_firingRange () const
SFInt32 get_firingRate () const
SFInt32 get_forceID () const
SFInt32 get_fuse () const
SFBool get_isActive () const
SFBool get_isCollided () const
SFBool get_isDetonated () const
SFBool get_isNetworkReader () const
SFBool get_isNetworkWriter () const
SFBool get_isRtpHeaderHeard () const
SFBool get_isStandAlone () const
SFVec3fget_linearAcceleration () const
SFVec3fget_linearVelocity () const
SFStringget_marking () const
SFStringget_multicastRelayHost () const
SFInt32 get_multicastRelayPort () const
SFInt32 get_munitionApplicationID () const
SFVec3fget_munitionEndPoint () const
SFInt32 get_munitionEntityID () const
SFInt32 get_munitionQuantity () const
SFInt32 get_munitionSiteID () const
SFVec3fget_munitionStartPoint () const
SFInt32 get_networkMode () const
SFInt32 get_port () const
SFTime get_readInterval () const
SFRotationget_rotation () const
SFBool get_rtpHeaderExpected () const
SFVec3fget_scale () const
SFRotationget_scaleOrientation () const
SFFloat get_set_articulationParameterValue0 () const
SFFloat get_set_articulationParameterValue1 () const
SFFloat get_set_articulationParameterValue2 () const
SFFloat get_set_articulationParameterValue3 () const
SFFloat get_set_articulationParameterValue4 () const
SFFloat get_set_articulationParameterValue5 () const
SFFloat get_set_articulationParameterValue6 () const
SFFloat get_set_articulationParameterValue7 () const
SFInt32 get_siteID () const
SFTime get_timestamp () const
SFVec3fget_translation () const
SFInt32 get_warhead () const
SFTime get_writeInterval () const
virtual field_t GetDefaultContainerField () const
 Get the name of the default container (SFNode or MFNode) for children nodes.
virtual const char * GetDefaultContainerFieldName () const
 Get the name of the default container (SFNode or MFNode) for children nodes.
virtual bool GetFieldByIndex (int idx, FieldInfo *info) const
 Get the content of a field using its index.
virtual bool GetFieldByName (field_t name, FieldInfo *info) const
 Get the content of a field using its name.
virtual int GetFieldCount () const
 Get the number of fields available at this level.
virtual bool GetFieldDefault (field_t name, FieldInfo *info) const
 Get the default value of a field.
virtual const char * GetNodeName () const
 Get the textual name of a node.
virtual field_t GetNodeType (int idx=0) const
 Get the type of a node.
virtual int GetTypeCount () const
 Get the number of types a node represents at its top-level.
virtual bool IsNodeType (field_t type) const
 Test whether a node is of a certain type.
void set_address (const SFString &address)
void set_applicationID (const SFInt32 &applicationID)
void set_articulationParameterArray (const MFFloat &articulationParameterArray)
void set_articulationParameterChangeIndicatorArray (const MFInt32 &articulationParameterChangeIndicatorArray)
void set_articulationParameterCount (const SFInt32 &articulationParameterCount)
void set_articulationParameterDesignatorArray (const MFInt32 &articulationParameterDesignatorArray)
void set_articulationParameterIdPartAttachedToArray (const MFInt32 &articulationParameterIdPartAttachedToArray)
void set_articulationParameterTypeArray (const MFInt32 &articulationParameterTypeArray)
void set_articulationParameterValue0_changed (const SFFloat &articulationParameterValue0_changed)
void set_articulationParameterValue1_changed (const SFFloat &articulationParameterValue1_changed)
void set_articulationParameterValue2_changed (const SFFloat &articulationParameterValue2_changed)
void set_articulationParameterValue3_changed (const SFFloat &articulationParameterValue3_changed)
void set_articulationParameterValue4_changed (const SFFloat &articulationParameterValue4_changed)
void set_articulationParameterValue5_changed (const SFFloat &articulationParameterValue5_changed)
void set_articulationParameterValue6_changed (const SFFloat &articulationParameterValue6_changed)
void set_articulationParameterValue7_changed (const SFFloat &articulationParameterValue7_changed)
void set_center (const SFVec3f &center)
void set_collideTime (const SFTime &collideTime)
void set_collisionType (const SFInt32 &collisionType)
void set_deadReckoning (const SFInt32 &deadReckoning)
void set_detonateTime (const SFTime &detonateTime)
void set_detonationLocation (const SFVec3f &detonationLocation)
void set_detonationRelativeLocation (const SFVec3f &detonationRelativeLocation)
void set_detonationResult (const SFInt32 &detonationResult)
void set_entityCategory (const SFInt32 &entityCategory)
void set_entityCountry (const SFInt32 &entityCountry)
void set_entityDomain (const SFInt32 &entityDomain)
void set_entityExtra (const SFInt32 &entityExtra)
void set_entityID (const SFInt32 &entityID)
void set_entityKind (const SFInt32 &entityKind)
void set_entitySpecific (const SFInt32 &entitySpecific)
void set_entitySubCategory (const SFInt32 &entitySubCategory)
void set_eventApplicationID (const SFInt32 &eventApplicationID)
void set_eventEntityID (const SFInt32 &eventEntityID)
void set_eventNumber (const SFInt32 &eventNumber)
void set_eventSiteID (const SFInt32 &eventSiteID)
void set_fired1 (const SFBool &fired1)
void set_fired2 (const SFBool &fired2)
void set_firedTime (const SFTime &firedTime)
void set_fireMissionIndex (const SFInt32 &fireMissionIndex)
void set_firingRange (const SFFloat &firingRange)
void set_firingRate (const SFInt32 &firingRate)
void set_forceID (const SFInt32 &forceID)
void set_fuse (const SFInt32 &fuse)
void set_isActive (const SFBool &isActive)
void set_isCollided (const SFBool &isCollided)
void set_isDetonated (const SFBool &isDetonated)
void set_isNetworkReader (const SFBool &isNetworkReader)
void set_isNetworkWriter (const SFBool &isNetworkWriter)
void set_isRtpHeaderHeard (const SFBool &isRtpHeaderHeard)
void set_isStandAlone (const SFBool &isStandAlone)
void set_linearAcceleration (const SFVec3f &linearAcceleration)
void set_linearVelocity (const SFVec3f &linearVelocity)
void set_marking (const SFString &marking)
void set_multicastRelayHost (const SFString &multicastRelayHost)
void set_multicastRelayPort (const SFInt32 &multicastRelayPort)
void set_munitionApplicationID (const SFInt32 &munitionApplicationID)
void set_munitionEndPoint (const SFVec3f &munitionEndPoint)
void set_munitionEntityID (const SFInt32 &munitionEntityID)
void set_munitionQuantity (const SFInt32 &munitionQuantity)
void set_munitionSiteID (const SFInt32 &munitionSiteID)
void set_munitionStartPoint (const SFVec3f &munitionStartPoint)
void set_networkMode (const SFInt32 &networkMode)
void set_port (const SFInt32 &port)
void set_readInterval (const SFTime &readInterval)
void set_rotation (const SFRotation &rotation)
void set_rtpHeaderExpected (const SFBool &rtpHeaderExpected)
void set_scale (const SFVec3f &scale)
void set_scaleOrientation (const SFRotation &scaleOrientation)
void set_set_articulationParameterValue0 (const SFFloat &set_articulationParameterValue0)
void set_set_articulationParameterValue1 (const SFFloat &set_articulationParameterValue1)
void set_set_articulationParameterValue2 (const SFFloat &set_articulationParameterValue2)
void set_set_articulationParameterValue3 (const SFFloat &set_articulationParameterValue3)
void set_set_articulationParameterValue4 (const SFFloat &set_articulationParameterValue4)
void set_set_articulationParameterValue5 (const SFFloat &set_articulationParameterValue5)
void set_set_articulationParameterValue6 (const SFFloat &set_articulationParameterValue6)
void set_set_articulationParameterValue7 (const SFFloat &set_articulationParameterValue7)
void set_siteID (const SFInt32 &siteID)
void set_timestamp (const SFTime &timestamp)
void set_translation (const SFVec3f &translation)
void set_warhead (const SFInt32 &warhead)
void set_writeInterval (const SFTime &writeInterval)
virtual bool SetFieldByName (field_t name, const void *data)
 Set the value of a field using its numeric name.
virtual ~EspduTransform ()

Protected Attributes

SFString f_address
SFInt32 f_applicationID
MFFloat f_articulationParameterArray
MFInt32 f_articulationParameterChangeIndicatorArray
SFInt32 f_articulationParameterCount
MFInt32 f_articulationParameterDesignatorArray
MFInt32 f_articulationParameterIdPartAttachedToArray
MFInt32 f_articulationParameterTypeArray
SFFloat f_articulationParameterValue0_changed
SFFloat f_articulationParameterValue1_changed
SFFloat f_articulationParameterValue2_changed
SFFloat f_articulationParameterValue3_changed
SFFloat f_articulationParameterValue4_changed
SFFloat f_articulationParameterValue5_changed
SFFloat f_articulationParameterValue6_changed
SFFloat f_articulationParameterValue7_changed
SFVec3f f_center
SFTime f_collideTime
SFInt32 f_collisionType
SFInt32 f_deadReckoning
SFTime f_detonateTime
SFVec3f f_detonationLocation
SFVec3f f_detonationRelativeLocation
SFInt32 f_detonationResult
SFInt32 f_entityCategory
SFInt32 f_entityCountry
SFInt32 f_entityDomain
SFInt32 f_entityExtra
SFInt32 f_entityID
SFInt32 f_entityKind
SFInt32 f_entitySpecific
SFInt32 f_entitySubCategory
SFInt32 f_eventApplicationID
SFInt32 f_eventEntityID
SFInt32 f_eventNumber
SFInt32 f_eventSiteID
SFBool f_fired1
SFBool f_fired2
SFTime f_firedTime
SFInt32 f_fireMissionIndex
SFFloat f_firingRange
SFInt32 f_firingRate
SFInt32 f_forceID
SFInt32 f_fuse
SFBool f_isActive
SFBool f_isCollided
SFBool f_isDetonated
SFBool f_isNetworkReader
SFBool f_isNetworkWriter
SFBool f_isRtpHeaderHeard
SFBool f_isStandAlone
SFVec3f f_linearAcceleration
SFVec3f f_linearVelocity
SFString f_marking
SFString f_multicastRelayHost
SFInt32 f_multicastRelayPort
SFInt32 f_munitionApplicationID
SFVec3f f_munitionEndPoint
SFInt32 f_munitionEntityID
SFInt32 f_munitionQuantity
SFInt32 f_munitionSiteID
SFVec3f f_munitionStartPoint
SFInt32 f_networkMode
SFInt32 f_networkMode__enum_last
SFString f_networkMode__enum_name
SFInt32 f_port
SFTime f_readInterval
SFRotation f_rotation
SFBool f_rtpHeaderExpected
SFVec3f f_scale
SFRotation f_scaleOrientation
SFFloat f_set_articulationParameterValue0
SFFloat f_set_articulationParameterValue1
SFFloat f_set_articulationParameterValue2
SFFloat f_set_articulationParameterValue3
SFFloat f_set_articulationParameterValue4
SFFloat f_set_articulationParameterValue5
SFFloat f_set_articulationParameterValue6
SFFloat f_set_articulationParameterValue7
SFInt32 f_siteID
SFTime f_timestamp
SFVec3f f_translation
SFInt32 f_warhead
SFTime f_writeInterval

Detailed Description

EspduTransform class definition automatically generated by html-to-header v1.0.

This class was automatically generated using the definition available in this modified X3D abstract: EspduTransform


Constructor & Destructor Documentation

x3d::EspduTransform::EspduTransform  ) 
 

virtual x3d::EspduTransform::~EspduTransform  )  [virtual]
 


Member Function Documentation

virtual bool x3d::EspduTransform::FieldHasDefaultValue field_t  name  )  const [virtual]
 

Test to know whether a field is currently set to its default value.

This function searches the specified field and test to know whether it is currently set to its default value. This is useful whenever saving to an XML file or some other format to avoid saving fields which are anyway set to their defaults. Also, the rendering process can make use of this to avoid changing the environment if it is not necessary.

Note:
A required field (i.e. marked as #REQUIRED in the DTD) does not have a default value and thus this function will always return false for these fields.
Parameters:
[in] name The name of the field to query in numeric form
Returns:
true if the field could be found and has a default value.
See also:
bool SFNode::GetFieldByName(field_t name, FieldInfo *info) const; bool SFNode::GetFieldByIndex(int idx, FieldInfo *info) const; bool SFNode::FieldHasDefaultValue(field_t name) const field_t GetField(const char *name);

Reimplemented from x3d::X3DGroupingNode.

SFString& x3d::EspduTransform::get_address  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_applicationID  )  const [inline]
 

MFFloat& x3d::EspduTransform::get_articulationParameterArray  )  const [inline]
 

MFInt32& x3d::EspduTransform::get_articulationParameterChangeIndicatorArray  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_articulationParameterCount  )  const [inline]
 

MFInt32& x3d::EspduTransform::get_articulationParameterDesignatorArray  )  const [inline]
 

MFInt32& x3d::EspduTransform::get_articulationParameterIdPartAttachedToArray  )  const [inline]
 

MFInt32& x3d::EspduTransform::get_articulationParameterTypeArray  )  const [inline]
 

SFFloat x3d::EspduTransform::get_articulationParameterValue0_changed  )  const [inline]
 

SFFloat x3d::EspduTransform::get_articulationParameterValue1_changed  )  const [inline]
 

SFFloat x3d::EspduTransform::get_articulationParameterValue2_changed  )  const [inline]
 

SFFloat x3d::EspduTransform::get_articulationParameterValue3_changed  )  const [inline]
 

SFFloat x3d::EspduTransform::get_articulationParameterValue4_changed  )  const [inline]
 

SFFloat x3d::EspduTransform::get_articulationParameterValue5_changed  )  const [inline]
 

SFFloat x3d::EspduTransform::get_articulationParameterValue6_changed  )  const [inline]
 

SFFloat x3d::EspduTransform::get_articulationParameterValue7_changed  )  const [inline]
 

SFVec3f& x3d::EspduTransform::get_center  )  const [inline]
 

SFTime x3d::EspduTransform::get_collideTime  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_collisionType  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_deadReckoning  )  const [inline]
 

SFTime x3d::EspduTransform::get_detonateTime  )  const [inline]
 

SFVec3f& x3d::EspduTransform::get_detonationLocation  )  const [inline]
 

SFVec3f& x3d::EspduTransform::get_detonationRelativeLocation  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_detonationResult  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_entityCategory  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_entityCountry  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_entityDomain  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_entityExtra  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_entityID  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_entityKind  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_entitySpecific  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_entitySubCategory  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_eventApplicationID  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_eventEntityID  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_eventNumber  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_eventSiteID  )  const [inline]
 

SFBool x3d::EspduTransform::get_fired1  )  const [inline]
 

SFBool x3d::EspduTransform::get_fired2  )  const [inline]
 

SFTime x3d::EspduTransform::get_firedTime  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_fireMissionIndex  )  const [inline]
 

SFFloat x3d::EspduTransform::get_firingRange  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_firingRate  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_forceID  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_fuse  )  const [inline]
 

SFBool x3d::EspduTransform::get_isActive  )  const [inline]
 

SFBool x3d::EspduTransform::get_isCollided  )  const [inline]
 

SFBool x3d::EspduTransform::get_isDetonated  )  const [inline]
 

SFBool x3d::EspduTransform::get_isNetworkReader  )  const [inline]
 

SFBool x3d::EspduTransform::get_isNetworkWriter  )  const [inline]
 

SFBool x3d::EspduTransform::get_isRtpHeaderHeard  )  const [inline]
 

SFBool x3d::EspduTransform::get_isStandAlone  )  const [inline]
 

SFVec3f& x3d::EspduTransform::get_linearAcceleration  )  const [inline]
 

SFVec3f& x3d::EspduTransform::get_linearVelocity  )  const [inline]
 

SFString& x3d::EspduTransform::get_marking  )  const [inline]
 

SFString& x3d::EspduTransform::get_multicastRelayHost  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_multicastRelayPort  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_munitionApplicationID  )  const [inline]
 

SFVec3f& x3d::EspduTransform::get_munitionEndPoint  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_munitionEntityID  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_munitionQuantity  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_munitionSiteID  )  const [inline]
 

SFVec3f& x3d::EspduTransform::get_munitionStartPoint  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_networkMode  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_port  )  const [inline]
 

SFTime x3d::EspduTransform::get_readInterval  )  const [inline]
 

SFRotation& x3d::EspduTransform::get_rotation  )  const [inline]
 

SFBool x3d::EspduTransform::get_rtpHeaderExpected  )  const [inline]
 

SFVec3f& x3d::EspduTransform::get_scale  )  const [inline]
 

SFRotation& x3d::EspduTransform::get_scaleOrientation  )  const [inline]
 

SFFloat x3d::EspduTransform::get_set_articulationParameterValue0  )  const [inline]
 

SFFloat x3d::EspduTransform::get_set_articulationParameterValue1  )  const [inline]
 

SFFloat x3d::EspduTransform::get_set_articulationParameterValue2  )  const [inline]
 

SFFloat x3d::EspduTransform::get_set_articulationParameterValue3  )  const [inline]
 

SFFloat x3d::EspduTransform::get_set_articulationParameterValue4  )  const [inline]
 

SFFloat x3d::EspduTransform::get_set_articulationParameterValue5  )  const [inline]
 

SFFloat x3d::EspduTransform::get_set_articulationParameterValue6  )  const [inline]
 

SFFloat x3d::EspduTransform::get_set_articulationParameterValue7  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_siteID  )  const [inline]
 

SFTime x3d::EspduTransform::get_timestamp  )  const [inline]
 

SFVec3f& x3d::EspduTransform::get_translation  )  const [inline]
 

SFInt32 x3d::EspduTransform::get_warhead  )  const [inline]
 

SFTime x3d::EspduTransform::get_writeInterval  )  const [inline]
 

virtual field_t x3d::EspduTransform::GetDefaultContainerField void   )  const [virtual]
 

Get the name of the default container (SFNode or MFNode) for children nodes.

This function returns the numeric name of the container field to use for children which are not given a specific place to be saved to. This is mainly for I/O purposes, whenever you are loading a file, you usually need to know where to save a new node in its parent.

Each node has a default field name where it is supposed to be saved in its parent node. Many nodes will return "children".

If no name is specified, this function returns FLD_INVALID. This means a saved node must specified the name of the container field otherwise the child cannot be saved in the parent.

Returns:
a field_t with the name of the field in which to save this node in its parent node
See also:
const char *SFNodeGetDefaultContainerFieldName(void) const;

Reimplemented from x3d::X3DGroupingNode.

virtual const char* x3d::EspduTransform::GetDefaultContainerFieldName void   )  const [virtual]
 

Get the name of the default container (SFNode or MFNode) for children nodes.

This function returns the textual name of the container field to use for children which do not have a specific place to be. This is mainly for I/O purposes, whenever you are loading a file, you usually need to know where to save a new node in its parent.

Each node has a default field name where it is supposed to be saved in its parent node. Many nodes will return "children".

If no name is specified, this function returns a null pointer. This means a saved node must specified the name of the container field otherwise the child cannot be saved in the parent.

If all you need is the numeric name, use the GetDefaultContainerFieldName() instead, it will be a lot faster.

Returns:
the name of the container field as a static const string an empty string or a null pointer
See also:
field_t SFNode::GetDefaultContainerField(void) const;

Reimplemented from x3d::X3DGroupingNode.

virtual bool x3d::EspduTransform::GetFieldByIndex int  idx,
FieldInfo info
const [virtual]
 

Get the content of a field using its index.

This function searches the specified field at the specified index and returns a pointer to its content, its type and its name in the provided info parameter.

This is used to enumerate all the fields of a node. The index starts at 0 and increases until the function returns false.

Warning:
Note that you can then read and write in the field. It is not adviced that you write in the field unless you know exactly what you are doing. You should instead use the set_ and get_ functions to read and write fields. This generic function is provided mainly for I/O operations.
Note:
The info are not modified if no field is found at the specified index.
Parameters:
[in] idx The index of the field to query
[in,out] info The structure where the information about the field is saved
Returns:
true if the field was found, false when the index is out of range
See also:
bool SFNode::GetFieldByName(field_t name, FieldInfo *info) const; int SFNode::GetFieldCount(void) const; field_t GetField(const char *name);

Reimplemented from x3d::X3DGroupingNode.

virtual bool x3d::EspduTransform::GetFieldByName field_t  name,
FieldInfo info
const [virtual]
 

Get the content of a field using its name.

This function searches the specified field and returns a pointer to its content, its type and its name in the provided info parameter.

Warning:
Note that you can then read and write in the field. It is not adviced that you write in the field unless you know exactly what you are doing. You should instead use the set_ and get_ functions to read and write fields. This generic function is provided mainly for I/O operations.
Parameters:
[in] name The name of the field to query in numeric form
[in,out] info The structure where the information about the field is saved
Returns:
true if the field was found
See also:
bool SFNode::GetFieldByIndex(int idx, FieldInfo *info) const; field_t GetField(const char *name);

Reimplemented from x3d::X3DGroupingNode.

virtual int x3d::EspduTransform::GetFieldCount void   )  const [virtual]
 

Get the number of fields available at this level.

This function returns the total number of fields this node supports. This can be used with a for() loop to query all the fields. It is also used internally to determine how to decrement the index to call the super class GetFieldByIndex() function.

In user defined types you need to call your super class GetFieldCount() and add the number of fields you offer:

 MyClass:GetFieldCount()
 {
        return X3DChildNode::GetFieldCount() + 5;
 }

Returns:
the total number of fields in this node and all its super classes
See also:
bool SFNode::GetFieldByIndex(int idx, FieldInfo *info) const; field_t GetField(const char *name);

Reimplemented from x3d::X3DGroupingNode.

virtual bool x3d::EspduTransform::GetFieldDefault field_t  name,
FieldInfo info
const [virtual]
 

Get the default value of a field.

Ask the node to return the default value of a field. It can be used to reset the field to that value or compare with the current value to know whether it is the default.

Note that to compare the current value of a field to its default, you should use the FieldHasDefaultValue() function instead (it is much more efficient and it compares all the different types for you.)

The returned value is the same as what you get when calling the GetFieldByName() or GetFieldByIndex() functions.

Note:
A required field (i.e. marked as #REQUIRED in the DTD) does not have a default value. This function will therefore return false for these fields.
Warning:
The returned FieldInfo will point to a static constant variable with the default value. The f_data pointer of the FieldInfo is unfortunately not set as a constant since once in a while you want to be able to modify the content of a field (especially MFNode's). However, modifying the default will either fail with a bus error/segmentation fault or you will lose access to the true default. Note that objects will still be initialized with the proper default and the FieldHasDefaultValue() will still work properly since each function has its own copy of the default values.
Parameters:
[in] name The name of the field to get the default of
[in,out] info A FieldInfo structure pointer where the default value is saved.
Returns:
true if the field could be found and has a default value.
See also:
bool SFNode::GetFieldByName(field_t name, FieldInfo *info) const; bool SFNode::GetFieldByIndex(int idx, FieldInfo *info) const; bool SFNode::FieldHasDefaultValue(field_t name) const field_t GetField(const char *name);

Reimplemented from x3d::X3DGroupingNode.

virtual const char* x3d::EspduTransform::GetNodeName void   )  const [virtual]
 

Get the textual name of a node.

The textual name of the node. This is also the name of the C++ class. it is used to load and save files in XML and VRML.

Returns:
a constant string (do not modify!)
See also:
field_t SFNode::GetNodeType(int idx) const;

Reimplemented from x3d::X3DGroupingNode.

virtual field_t x3d::EspduTransform::GetNodeType int  idx = 0  )  const [virtual]
 

Get the type of a node.

Get the type (such as FLD_TYPE_SCRIPT) of a node. The index can be used in order to query all the types. With index 0, only the top-most type is returned. Once all the types have been returned, the function returns FLD_INVALID.

The following example checks whether a node is of type grouping. Note that it is faster to use IsNodeType() in this case unless you want to test for several types.

 for(;;) {
        field_t t = node->GetNodeType();
        if(t == FLD_INVALID) return ERROR;
        if(t == FLD_GROUPING) return VALID;
 }

Parameters:
[in] idx the index of the node of which we want to get the type
Returns:
a field_t with the corresponding node type
See also:
bool SFNode::IsNodeType(field_t type) const;

Reimplemented from x3d::X3DGroupingNode.

virtual int x3d::EspduTransform::GetTypeCount void   )  const [virtual]
 

Get the number of types a node represents at its top-level.

In order for the GetNodeType() function to work properly, we need to have a way to know how many types may be handled at a given level. This function is used for that purpose to decrement the index properly when calling a different level.

Returns:
a field_t with the corresponding node type
See also:
bool SFNode::IsNodeType(field_t type) const;

Reimplemented from x3d::X3DGroupingNode.

virtual bool x3d::EspduTransform::IsNodeType field_t  type  )  const [virtual]
 

Test whether a node is of a certain type.

Nodes inherit of different classes. To know whether a node is derived of a specific class you can use dynamic_cast<typename>(node) where typename is the name of the derived class. This can be rather slow since the textual name is used to find the proper pointer. So if you do not need the pointer afterward, you should instead use this function. It will go through all the classes, but it only has to compare one integer to know whether it is of that class or not.

 if(node->IsNodeType(FLD_TYPE_SCRIPT)) HandleScript(); 

Parameters:
[in] type one of the FLD_TYPE_... enumeration or a user registered type
Returns:
true whenever the node is of that type
See also:
field_t SFNode::GetNodeType(int idx) const;

Reimplemented from x3d::X3DGroupingNode.

void x3d::EspduTransform::set_address const SFString address  )  [inline]
 

void x3d::EspduTransform::set_applicationID const SFInt32 applicationID  )  [inline]
 

void x3d::EspduTransform::set_articulationParameterArray const MFFloat articulationParameterArray  )  [inline]
 

void x3d::EspduTransform::set_articulationParameterChangeIndicatorArray const MFInt32 articulationParameterChangeIndicatorArray  )  [inline]
 

void x3d::EspduTransform::set_articulationParameterCount const SFInt32 articulationParameterCount  )  [inline]
 

void x3d::EspduTransform::set_articulationParameterDesignatorArray const MFInt32 articulationParameterDesignatorArray  )  [inline]
 

void x3d::EspduTransform::set_articulationParameterIdPartAttachedToArray const MFInt32 articulationParameterIdPartAttachedToArray  )  [inline]
 

void x3d::EspduTransform::set_articulationParameterTypeArray const MFInt32 articulationParameterTypeArray  )  [inline]
 

void x3d::EspduTransform::set_articulationParameterValue0_changed const SFFloat articulationParameterValue0_changed  )  [inline]
 

void x3d::EspduTransform::set_articulationParameterValue1_changed const SFFloat articulationParameterValue1_changed  )  [inline]
 

void x3d::EspduTransform::set_articulationParameterValue2_changed const SFFloat articulationParameterValue2_changed  )  [inline]
 

void x3d::EspduTransform::set_articulationParameterValue3_changed const SFFloat articulationParameterValue3_changed  )  [inline]
 

void x3d::EspduTransform::set_articulationParameterValue4_changed const SFFloat articulationParameterValue4_changed  )  [inline]
 

void x3d::EspduTransform::set_articulationParameterValue5_changed const SFFloat articulationParameterValue5_changed  )  [inline]
 

void x3d::EspduTransform::set_articulationParameterValue6_changed const SFFloat articulationParameterValue6_changed  )  [inline]
 

void x3d::EspduTransform::set_articulationParameterValue7_changed const SFFloat articulationParameterValue7_changed  )  [inline]
 

void x3d::EspduTransform::set_center const SFVec3f center  )  [inline]
 

void x3d::EspduTransform::set_collideTime const SFTime collideTime  )  [inline]
 

void x3d::EspduTransform::set_collisionType const SFInt32 collisionType  )  [inline]
 

void x3d::EspduTransform::set_deadReckoning const SFInt32 deadReckoning  )  [inline]
 

void x3d::EspduTransform::set_detonateTime const SFTime detonateTime  )  [inline]
 

void x3d::EspduTransform::set_detonationLocation const SFVec3f detonationLocation  )  [inline]
 

void x3d::EspduTransform::set_detonationRelativeLocation const SFVec3f detonationRelativeLocation  )  [inline]
 

void x3d::EspduTransform::set_detonationResult const SFInt32 detonationResult  )  [inline]
 

void x3d::EspduTransform::set_entityCategory const SFInt32 entityCategory  )  [inline]
 

void x3d::EspduTransform::set_entityCountry const SFInt32 entityCountry  )  [inline]
 

void x3d::EspduTransform::set_entityDomain const SFInt32 entityDomain  )  [inline]
 

void x3d::EspduTransform::set_entityExtra const SFInt32 entityExtra  )  [inline]
 

void x3d::EspduTransform::set_entityID const SFInt32 entityID  )  [inline]
 

void x3d::EspduTransform::set_entityKind const SFInt32 entityKind  )  [inline]
 

void x3d::EspduTransform::set_entitySpecific const SFInt32 entitySpecific  )  [inline]
 

void x3d::EspduTransform::set_entitySubCategory const SFInt32 entitySubCategory  )  [inline]
 

void x3d::EspduTransform::set_eventApplicationID const SFInt32 eventApplicationID  )  [inline]
 

void x3d::EspduTransform::set_eventEntityID const SFInt32 eventEntityID  )  [inline]
 

void x3d::EspduTransform::set_eventNumber const SFInt32 eventNumber  )  [inline]
 

void x3d::EspduTransform::set_eventSiteID const SFInt32 eventSiteID  )  [inline]
 

void x3d::EspduTransform::set_fired1 const SFBool fired1  )  [inline]
 

void x3d::EspduTransform::set_fired2 const SFBool fired2  )  [inline]
 

void x3d::EspduTransform::set_firedTime const SFTime firedTime  )  [inline]
 

void x3d::EspduTransform::set_fireMissionIndex const SFInt32 fireMissionIndex  )  [inline]
 

void x3d::EspduTransform::set_firingRange const SFFloat firingRange  )  [inline]
 

void x3d::EspduTransform::set_firingRate const SFInt32 firingRate  )  [inline]
 

void x3d::EspduTransform::set_forceID const SFInt32 forceID  )  [inline]
 

void x3d::EspduTransform::set_fuse const SFInt32 fuse  )  [inline]
 

void x3d::EspduTransform::set_isActive const SFBool isActive  )  [inline]
 

void x3d::EspduTransform::set_isCollided const SFBool isCollided  )  [inline]
 

void x3d::EspduTransform::set_isDetonated const SFBool isDetonated  )  [inline]
 

void x3d::EspduTransform::set_isNetworkReader const SFBool isNetworkReader  )  [inline]
 

void x3d::EspduTransform::set_isNetworkWriter const SFBool isNetworkWriter  )  [inline]
 

void x3d::EspduTransform::set_isRtpHeaderHeard const SFBool isRtpHeaderHeard  )  [inline]
 

void x3d::EspduTransform::set_isStandAlone const SFBool isStandAlone  )  [inline]
 

void x3d::EspduTransform::set_linearAcceleration const SFVec3f linearAcceleration  )  [inline]
 

void x3d::EspduTransform::set_linearVelocity const SFVec3f linearVelocity  )  [inline]
 

void x3d::EspduTransform::set_marking const SFString marking  )  [inline]
 

void x3d::EspduTransform::set_multicastRelayHost const SFString multicastRelayHost  )  [inline]
 

void x3d::EspduTransform::set_multicastRelayPort const SFInt32 multicastRelayPort  )  [inline]
 

void x3d::EspduTransform::set_munitionApplicationID const SFInt32 munitionApplicationID  )  [inline]
 

void x3d::EspduTransform::set_munitionEndPoint const SFVec3f munitionEndPoint  )  [inline]
 

void x3d::EspduTransform::set_munitionEntityID const SFInt32 munitionEntityID  )  [inline]
 

void x3d::EspduTransform::set_munitionQuantity const SFInt32 munitionQuantity  )  [inline]
 

void x3d::EspduTransform::set_munitionSiteID const SFInt32 munitionSiteID  )  [inline]
 

void x3d::EspduTransform::set_munitionStartPoint const SFVec3f munitionStartPoint  )  [inline]
 

void x3d::EspduTransform::set_networkMode const SFInt32 networkMode  )  [inline]
 

void x3d::EspduTransform::set_port const SFInt32 port  )  [inline]
 

void x3d::EspduTransform::set_readInterval const SFTime readInterval  )  [inline]
 

void x3d::EspduTransform::set_rotation const SFRotation rotation  )  [inline]
 

void x3d::EspduTransform::set_rtpHeaderExpected const SFBool rtpHeaderExpected  )  [inline]
 

void x3d::EspduTransform::set_scale const SFVec3f scale  )  [inline]
 

void x3d::EspduTransform::set_scaleOrientation const SFRotation scaleOrientation  )  [inline]
 

void x3d::EspduTransform::set_set_articulationParameterValue0 const SFFloat set_articulationParameterValue0  )  [inline]
 

void x3d::EspduTransform::set_set_articulationParameterValue1 const SFFloat set_articulationParameterValue1  )  [inline]
 

void x3d::EspduTransform::set_set_articulationParameterValue2 const SFFloat set_articulationParameterValue2  )  [inline]
 

void x3d::EspduTransform::set_set_articulationParameterValue3 const SFFloat set_articulationParameterValue3  )  [inline]
 

void x3d::EspduTransform::set_set_articulationParameterValue4 const SFFloat set_articulationParameterValue4  )  [inline]
 

void x3d::EspduTransform::set_set_articulationParameterValue5 const SFFloat set_articulationParameterValue5  )  [inline]
 

void x3d::EspduTransform::set_set_articulationParameterValue6 const SFFloat set_articulationParameterValue6  )  [inline]
 

void x3d::EspduTransform::set_set_articulationParameterValue7 const SFFloat set_articulationParameterValue7  )  [inline]
 

void x3d::EspduTransform::set_siteID const SFInt32 siteID  )  [inline]
 

void x3d::EspduTransform::set_timestamp const SFTime timestamp  )  [inline]
 

void x3d::EspduTransform::set_translation const SFVec3f translation  )  [inline]
 

void x3d::EspduTransform::set_warhead const SFInt32 warhead  )  [inline]
 

void x3d::EspduTransform::set_writeInterval const SFTime writeInterval  )  [inline]
 

virtual bool x3d::EspduTransform::SetFieldByName field_t  name,
const void *  data
[virtual]
 

Set the value of a field using its numeric name.

This function is mainly to be used by I/O operations to change the value of a field from the value found in an input stream.

For other purposes, it is strongly advise that you make use of the get_ and set_ functions of the given class.

Also, if you are not sure about the datatype of a field, it is better to use the other SetFieldByName() function which will automatically determine the type of the field and set it accordingly.

Attention:
Enumeration fields are managed differently depending on the function that you use. This one will make that field look like an SFString. The data pointer is expected to point to an SFString or it will crash. Internally, the string will be transformed to the corresponding enumeration value. Note that if the field name is valid, but the enumeration name is not, then the function also returns false.
Note:
You cannot set a node in a parent node using this function.
Parameters:
[in] name The name of the field to set.
[in] data A pointer to the data to copy in the specified field. It MUST be of the right type of the system may crash. This is the same pointer as found the FieldInfo.f_data.f_any variable member.
Returns:
true when a field of the specified name was found and set to the value defined by data
Bug:
At this time, the data pointer is of type void* and there is therfore no way for sure to know whether the pointer passed is of the type expected by the field. This should be fine since this function is mainly to be used by I/O processes and no specialized code which can handle the fields using the proper get_ and set_ functions.
See also:
field_t SFNode::SetFieldByName(const char *name, const char *data);

Reimplemented from x3d::X3DGroupingNode.


Member Data Documentation

SFString x3d::EspduTransform::f_address [protected]
 

SFInt32 x3d::EspduTransform::f_applicationID [protected]
 

MFFloat x3d::EspduTransform::f_articulationParameterArray [protected]
 

MFInt32 x3d::EspduTransform::f_articulationParameterChangeIndicatorArray [protected]
 

SFInt32 x3d::EspduTransform::f_articulationParameterCount [protected]
 

MFInt32 x3d::EspduTransform::f_articulationParameterDesignatorArray [protected]
 

MFInt32 x3d::EspduTransform::f_articulationParameterIdPartAttachedToArray [protected]
 

MFInt32 x3d::EspduTransform::f_articulationParameterTypeArray [protected]
 

SFFloat x3d::EspduTransform::f_articulationParameterValue0_changed [protected]
 

SFFloat x3d::EspduTransform::f_articulationParameterValue1_changed [protected]
 

SFFloat x3d::EspduTransform::f_articulationParameterValue2_changed [protected]
 

SFFloat x3d::EspduTransform::f_articulationParameterValue3_changed [protected]
 

SFFloat x3d::EspduTransform::f_articulationParameterValue4_changed [protected]
 

SFFloat x3d::EspduTransform::f_articulationParameterValue5_changed [protected]
 

SFFloat x3d::EspduTransform::f_articulationParameterValue6_changed [protected]
 

SFFloat x3d::EspduTransform::f_articulationParameterValue7_changed [protected]
 

SFVec3f x3d::EspduTransform::f_center [protected]
 

SFTime x3d::EspduTransform::f_collideTime [protected]
 

SFInt32 x3d::EspduTransform::f_collisionType [protected]
 

SFInt32 x3d::EspduTransform::f_deadReckoning [protected]
 

SFTime x3d::EspduTransform::f_detonateTime [protected]
 

SFVec3f x3d::EspduTransform::f_detonationLocation [protected]
 

SFVec3f x3d::EspduTransform::f_detonationRelativeLocation [protected]
 

SFInt32 x3d::EspduTransform::f_detonationResult [protected]
 

SFInt32 x3d::EspduTransform::f_entityCategory [protected]
 

SFInt32 x3d::EspduTransform::f_entityCountry [protected]
 

SFInt32 x3d::EspduTransform::f_entityDomain [protected]
 

SFInt32 x3d::EspduTransform::f_entityExtra [protected]
 

SFInt32 x3d::EspduTransform::f_entityID [protected]
 

SFInt32 x3d::EspduTransform::f_entityKind [protected]
 

SFInt32 x3d::EspduTransform::f_entitySpecific [protected]
 

SFInt32 x3d::EspduTransform::f_entitySubCategory [protected]
 

SFInt32 x3d::EspduTransform::f_eventApplicationID [protected]
 

SFInt32 x3d::EspduTransform::f_eventEntityID [protected]
 

SFInt32 x3d::EspduTransform::f_eventNumber [protected]
 

SFInt32 x3d::EspduTransform::f_eventSiteID [protected]
 

SFBool x3d::EspduTransform::f_fired1 [protected]
 

SFBool x3d::EspduTransform::f_fired2 [protected]
 

SFTime x3d::EspduTransform::f_firedTime [protected]
 

SFInt32 x3d::EspduTransform::f_fireMissionIndex [protected]
 

SFFloat x3d::EspduTransform::f_firingRange [protected]
 

SFInt32 x3d::EspduTransform::f_firingRate [protected]
 

SFInt32 x3d::EspduTransform::f_forceID [protected]
 

SFInt32 x3d::EspduTransform::f_fuse [protected]
 

SFBool x3d::EspduTransform::f_isActive [protected]
 

SFBool x3d::EspduTransform::f_isCollided [protected]
 

SFBool x3d::EspduTransform::f_isDetonated [protected]
 

SFBool x3d::EspduTransform::f_isNetworkReader [protected]
 

SFBool x3d::EspduTransform::f_isNetworkWriter [protected]
 

SFBool x3d::EspduTransform::f_isRtpHeaderHeard [protected]
 

SFBool x3d::EspduTransform::f_isStandAlone [protected]
 

SFVec3f x3d::EspduTransform::f_linearAcceleration [protected]
 

SFVec3f x3d::EspduTransform::f_linearVelocity [protected]
 

SFString x3d::EspduTransform::f_marking [protected]
 

SFString x3d::EspduTransform::f_multicastRelayHost [protected]
 

SFInt32 x3d::EspduTransform::f_multicastRelayPort [protected]
 

SFInt32 x3d::EspduTransform::f_munitionApplicationID [protected]
 

SFVec3f x3d::EspduTransform::f_munitionEndPoint [protected]
 

SFInt32 x3d::EspduTransform::f_munitionEntityID [protected]
 

SFInt32 x3d::EspduTransform::f_munitionQuantity [protected]
 

SFInt32 x3d::EspduTransform::f_munitionSiteID [protected]
 

SFVec3f x3d::EspduTransform::f_munitionStartPoint [protected]
 

SFInt32 x3d::EspduTransform::f_networkMode [protected]
 

SFInt32 x3d::EspduTransform::f_networkMode__enum_last [mutable, protected]
 

SFString x3d::EspduTransform::f_networkMode__enum_name [mutable, protected]
 

SFInt32 x3d::EspduTransform::f_port [protected]
 

SFTime x3d::EspduTransform::f_readInterval [protected]
 

SFRotation x3d::EspduTransform::f_rotation [protected]
 

SFBool x3d::EspduTransform::f_rtpHeaderExpected [protected]
 

SFVec3f x3d::EspduTransform::f_scale [protected]
 

SFRotation x3d::EspduTransform::f_scaleOrientation [protected]
 

SFFloat x3d::EspduTransform::f_set_articulationParameterValue0 [protected]
 

SFFloat x3d::EspduTransform::f_set_articulationParameterValue1 [protected]
 

SFFloat x3d::EspduTransform::f_set_articulationParameterValue2 [protected]
 

SFFloat x3d::EspduTransform::f_set_articulationParameterValue3 [protected]
 

SFFloat x3d::EspduTransform::f_set_articulationParameterValue4 [protected]
 

SFFloat x3d::EspduTransform::f_set_articulationParameterValue5 [protected]
 

SFFloat x3d::EspduTransform::f_set_articulationParameterValue6 [protected]
 

SFFloat x3d::EspduTransform::f_set_articulationParameterValue7 [protected]
 

SFInt32 x3d::EspduTransform::f_siteID [protected]
 

SFTime x3d::EspduTransform::f_timestamp [protected]
 

SFVec3f x3d::EspduTransform::f_translation [protected]
 

SFInt32 x3d::EspduTransform::f_warhead [protected]
 

SFTime x3d::EspduTransform::f_writeInterval [protected]
 


The documentation for this class was generated from the following file: