ScXMLDataElt(3)

πŸ“¦
version 4.0.10 Β· 4 versions
, in fedora 43, fedora 44

πŸ’– ScXMLDataElt πŸ’–

okay bestie, welcome to the ScXMLDataElt(3) page, straight outta the Coin manual ✨ this is the one about the <data> SCXML element and honestly? it's giving variable storage icon behavior πŸ‘‘


πŸŽ€ NAME πŸŽ€

ScXMLDataElt β€” the <data> SCXML element. periodt.


🌸 SYNOPSIS 🌸

#include <Inventor/scxml/ScXMLDataElt.h>

Inherits ScXMLElt.

πŸ’… Public Member Functions

  • virtual SoType getTypeId (void) const β€” hands you the type identification of an object derived from a class inheriting SoBase. it's what runtime type checking and "downward" casting run on, no cap.
  • virtual void setIDAttribute (const char *ID)
  • virtual const char * getIDAttribute (void) const
  • virtual void setSrcAttribute (const char *src)
  • virtual const char * getSrcAttribute (void) const
  • virtual void setExprAttribute (const char *expr)
  • virtual const char * getExprAttribute (void) const
  • virtual SbBool handleXMLAttributes (void)
  • virtual void copyContents (const ScXMLElt *rhs)
  • virtual const ScXMLElt * search (const char *attrname, const char *attrvalue) const
  • virtual void setValueObj (ScXMLDataObj *value)
  • virtual ScXMLDataObj * getValueObj (void) const

πŸ¦‹ Public Member Functions inherited from ScXMLElt

  • void setXMLAttribute (const char *attribute, const char *value)
  • const char * getXMLAttribute (const char *attribute) const
  • ScXMLElt * clone (void) const
  • virtual void setContainer (ScXMLElt *container)
  • ScXMLElt * getContainer (void) const
  • SbBool isContainedIn (const ScXMLElt *object) const

🫢 Public Member Functions inherited from ScXMLObject

  • SbBool isOfType (SoType type) const β€” returns TRUE if the type of this object is either of the same type or inherited from type. slay.

✨ Static Public Member Functions

  • static ScXMLEltReader * getElementReader (void)
  • static SoType getClassTypeId (void)
  • static void * createInstance (void)
  • static void initClass (void)
  • static void cleanClass (void)

🌈 Static Public Member Functions inherited from ScXMLElt

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static void cleanClass (void)

⭐ Static Public Member Functions inherited from ScXMLObject

  • static SoType getClassTypeId (void) β€” this static method returns the SoType object associated with objects of this class.
  • static void initClass (void) β€” sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static void cleanClass (void) β€” does the opposite of initClass, deallocates any class specific resources and resets the class to an uninitialized state with respect to the Coin type system.

πŸ’œ Protected Attributes

  • char * ID
  • char * src
  • char * expr
  • ScXMLDataObj * value

🧚 Additional Inherited Members

Static Protected Member Functions inherited from ScXMLElt

  • static void registerClassType (const char *xmlns, const char *classname, SoType type)
  • static void registerInvokeClassType (const char *xmlns, const char *targettype, const char *source, SoType type)

Static Protected Member Functions inherited from ScXMLObject

  • static void registerClassType (const char *xmlns, const char *classname, SoType type)
  • static void registerInvokeClassType (const char *xmlns, const char *targettype, const char *source, SoType type)

πŸ‘‘ Detailed Description πŸ‘‘

the <data> SCXML element. that's the whole vibe of this class, fr fr.

The <data> SCXML element is for storing variables. πŸ“ They need to be contained within a <datamodel> element. <data> elements are only functional in state machines with a profile that has an implementation of the Data Module. The "minimum" profile does not, but the "x-coin" profile does. (so pick your profile wisely bestie, it's lowkey a whole thing 😭)

The following attributes are accepted:

  • ID
  • src β€” not supported πŸ™ˆ
  • expr

The ID attribute is required and specifies the variable name. The variable name must be unique for the whole SCXML state machine specification. (yes, the whole thing, don't be messy πŸ’…)

The src attribute is not supported. like, at all. moving on.

The expr attribute specifies the value of the variable. The attribute is evaluated based on which profile the state machine is using.

The value of the <data> variable can be changed through the use of <assign> elements, and their values can be passed on to other systems through the use of the <send> element in the External Communications Module. πŸ”₯

  • Since β€” Coin 4.0
  • See also β€” ScXMLDataModelElt, ScXMLAssignElt, ScXMLSendElt

πŸ’€ Member Function Documentation πŸ’€

🌸 SoType ScXMLDataElt::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

  • See also β€” SoBase::getTypeId() const
  • Implements β€” ScXMLElt.

πŸ¦‹ SbBool ScXMLDataElt::handleXMLAttributes (void ) [virtual]

This method is called when the file reader has set all the XML attributes on the object, and wants the object to handle them and report if the values were OK or if a read error should be produced.

  • Returns β€” TRUE if the attributes are OK, and FALSE on error.

This base class implementation does nothing and just returns TRUE. (iconic minimal effort behavior honestly ✨)

  • Reimplemented from β€” ScXMLElt.

πŸ’– void ScXMLDataElt::copyContents (const ScXMLElt * rhs) [virtual]

  • Reimplemented from β€” ScXMLElt.

πŸŽ€ const ScXMLElt * ScXMLDataElt::search (const char * attrname, const char * attrvalue) const [virtual]

This method searches the SCXML structure for an element with the given attribute value for the given attribute.

Returns NULL if nothing was found. 😭

This function needs to be reimplemented to traverse child elements.

  • Reimplemented from β€” ScXMLElt.

🌟 Author 🌟

Generated automatically by Doxygen for Coin from the source code. (not a human, just a very diligent robot 🫢)


okay that's the whole page bestie, you ate that πŸ’…βœ¨ this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and yes it's ScXMLDataElt(3) in the Coin manual, so go forth and store those variables responsibly, mwah πŸ’–πŸ¦‹πŸŒΈ

πŸ“¦ where this page comes from