ScXMLAssignElt(3)

💖 ScXMLAssignElt 💖

okay bestie, so this is the manual page for ScXMLAssignElt(3) from the Coin library, and no cap it's the <assign> SCXML element. grab a strawberry drink, we're doing this 🍓

---

✨ NAME ✨

ScXMLAssignElt — literally just the <assign> SCXML element. that's it, that's the vibe 💅

---

🌈 SYNOPSIS 🌈

#include <Inventor/scxml/ScXMLAssignElt.h>

Inherits ScXMLExecutableElt. so it's giving family tree, we love a legacy 😌

🌸 Public Member Functions 🌸

• virtual SoType getTypeId (void) const — returns the type identification of an object derived from a class inheriting SoBase. this is the whole runtime-type-checking-and-"downward"-casting situation.
• ScXMLAssignElt (void) — the constructor, we'll get to it.
• virtual void setLocationAttribute (const char *location)
• virtual const char * getLocationAttribute (void) const
• virtual void setDataIDAttribute (const char *dataID)
• virtual const char * getDataIDAttribute (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 execute (ScXMLStateMachine *statemachine) 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. periodt.

⭐ 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 ScXMLExecutableElt 💜

• static SoType getClassTypeId (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. it's giving setup era ✨
• 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. the breakup arc 😭

🔥 Protected Attributes 🔥

• char * location
• char * dataID
• char * expr

🌟 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 <assign> SCXML element. lowkey iconic.

The <assign> element is only functional under a profile that has an implementation of the Data Module. The "minimum" profile does not implement one, but the "x-coin" profile does. so like, pick your profile wisely bestie 💀

The following attributes are accepted:

• location
• dataID
• expr

Either location or dataID can be specified at a time. not both, we don't do that here 🚫

If dataID is specified, then the target of the assignment is the <data> element that has the ID attribute set to the same value.

If location is specified, a profile-dependent variable addressing is used. The "minimum" profile does not define any, and the "x-coin" profile defines the following address schemes for writable variables:

• _data.{id} means targeting an existing <data> variable.
• coin:temp.{id} means targeting a temporary variable, creating one if necessary.

Temporary variables in the "x-coin" profile have the lifetime of one SCXML event. To have persistent data, use <data> variables. They stay alive for the same duration the ScXMLStateMachine exists. so basically temp vars are the fleeting situationship and <data> vars are the long-term commitment 💖

Temporary variables are particularly useful for the <send> element, because the namelist attribute can address them with implicit prefix, which means the event targets can read them out based on logical names instead of SCXML data model addresses. iykyk 😌

See also

ScXMLDataModelElt, ScXMLDataElt, ScXMLSendElt

---

🛠️ Constructor & Destructor Documentation 🛠️

ScXMLAssignElt::ScXMLAssignElt (void )

Constructor that sets up an empty ScXMLAssignElt object. a blank slate, main character origin story fr fr ✨

---

💅 Member Function Documentation 💅

SoType ScXMLAssignElt::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 ScXMLExecutableElt.

void ScXMLAssignElt::initClass (void ) [static]

Creates the ScXMLAssignElt class type SoType object. we're manifesting the type 🫶

void ScXMLAssignElt::cleanClass (void ) [static]

Cleans out the class type SoType object. and we're clearing it, no baggage 💅

SbBool ScXMLAssignElt::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. so if you were expecting drama, there is none, it's just chilling 😴

Reimplemented from ScXMLElt.

void ScXMLAssignElt::copyContents (const ScXMLElt * rhs) [virtual]

Reimplemented from ScXMLExecutableElt.

const ScXMLElt * ScXMLAssignElt::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. it's giving detective energy 🔍

Returns NULL if nothing was found. sad, but honest 😭

This function needs to be reimplemented to traverse child elements.

Reimplemented from ScXMLElt.

void ScXMLAssignElt::execute (ScXMLStateMachine * statemachine) const [virtual]

Reimplemented from ScXMLExecutableElt.

---

🦋 Author 🦋

Generated automatically by Doxygen for Coin from the source code. not a human, but honestly the automation ate 💅✨

---

and that's the whole page bestie!! this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00 — so like, future-proofed and everything. go forth and assign, you've got this 🫶💖🌸