ScXMLStateElt(3)

🎀 ScXMLStateElt 💖💅

okay so bestie, welcome to another page of the Coin manual — that's section 3, the library-functions zone, iykyk — and today's main character is ScXMLStateElt. She implements the <state> SCXML element. That's the whole vibe. 🦋

---

✨ NAME ✨

ScXMLStateElt — implements the <state> SCXML element. 💖

---

🌈 SYNOPSIS 🌈

#include <Inventor/scxml/ScXMLStateElt.h>

Inherits ScXMLAbstractStateElt. 🌸

💜 Public Member Functions 💜

• virtual SoType getTypeId (void) const — hands you the type identification for an object derived from a class that inherits SoBase. It's what powers runtime type checking and "downward" casting. 🎯
• ScXMLStateElt (void) — the constructor.
• virtual ~ScXMLStateElt (void) — the destructor.
• virtual void setSrcAttribute (const char *src) — sets the src thing.
• const char * getSrcAttribute (void) const — gets the src thing back out.
• virtual void setInitialAttribute (const char *initial) — sets the initial thing.
• const char * getInitialAttribute (void) const — gets the initial thing back out.
• virtual SbBool handleXMLAttributes (void) — handles the XML attributes.
• virtual void copyContents (const ScXMLElt *rhs) — copies the contents.
• virtual const ScXMLElt * search (const char *attrname, const char *attrvalue) const — searches for stuff. 🔍
• virtual void setOnEntry (ScXMLOnEntryElt *onentry) — sets the on-entry element.
• virtual ScXMLOnEntryElt * getOnEntry (void) const — gets the on-entry element.
• virtual void setOnExit (ScXMLOnExitElt *onexit) — sets the on-exit element.
• virtual ScXMLOnExitElt * getOnExit (void) const — gets the on-exit element.
• virtual int getNumTransitions (void) const — how many transitions we got.
• virtual ScXMLTransitionElt * getTransition (int idx) const — grab transition number idx.
• virtual void addTransition (ScXMLTransitionElt *transition) — add a transition.
• virtual void removeTransition (ScXMLTransitionElt *transition) — remove a transition.
• virtual void clearAllTransitions (void) — nuke every transition. 💀
• virtual void setInitial (ScXMLInitialElt *initial) — set the <initial> element.
• virtual ScXMLInitialElt * getInitial (void) const — get the <initial> element.
• virtual int getNumStates (void) const — how many child states.
• virtual ScXMLStateElt * getState (int idx) const — grab state number idx.
• virtual void addState (ScXMLStateElt *state) — add a child state.
• virtual void removeState (ScXMLStateElt *state) — remove a child state.
• virtual void clearAllStates (void) — bye to every child state.
• virtual int getNumParallels (void) const — how many parallels.
• virtual ScXMLParallelElt * getParallel (int idx) const — grab parallel number idx.
• virtual void addParallel (ScXMLParallelElt *state) — add a parallel.
• virtual void removeParallel (ScXMLParallelElt *state) — remove a parallel.
• virtual void clearAllParallels (void) — clear every parallel.
• virtual int getNumFinals (void) const — how many finals.
• virtual ScXMLFinalElt * getFinal (int idx) const — grab final number idx.
• virtual void addFinal (ScXMLFinalElt *state) — add a final.
• virtual void removeFinal (ScXMLFinalElt *state) — remove a final.
• virtual void clearAllFinals (void) — clear every final.
• virtual int getNumHistories (void) const — how many histories.
• virtual ScXMLHistoryElt * getHistory (int idx) const — grab history number idx.
• virtual void addHistory (ScXMLHistoryElt *history) — add a history.
• virtual void removeHistory (ScXMLHistoryElt *history) — remove a history.
• virtual void clearAllHistories (void) — clear every history.
• virtual int getNumAnchors (void) const — how many anchors.
• virtual ScXMLAnchorElt * getAnchor (int idx) const — grab anchor number idx.
• virtual void addAnchor (ScXMLAnchorElt *anchor) — add an anchor.
• virtual void removeAnchor (ScXMLAnchorElt *anchor) — remove an anchor.
• virtual void clearAllAnchors (void) — clear every anchor.
• virtual void setDataModel (ScXMLDataModelElt *datamodel) — set the data model.
• virtual ScXMLDataModelElt * getDataModel (void) const — get the data model.
• SbBool isAtomicState (void) const — is she an atomic state? 👑

💫 Public Member Functions inherited from ScXMLAbstractStateElt 💫

• virtual void setIdAttribute (const char *id) — sets the id attribute.
• const char * getIdAttribute (void) const — returns the id attribute.

💫 Public Member Functions inherited from ScXMLElt 💫

• void setXMLAttribute (const char *attribute, const char *value) — sets an XML attribute.
• const char * getXMLAttribute (const char *attribute) const — gets an XML attribute.
• ScXMLElt * clone (void) const — clones the element.
• virtual void setContainer (ScXMLElt *container) — sets the container.
• ScXMLElt * getContainer (void) const — gets the container.
• SbBool isContainedIn (const ScXMLElt *object) const — checks containment.

💫 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 as type or inherited from type. ✅

🌟 Static Public Member Functions 🌟

• static ScXMLEltReader * getElementReader (void) — gets the element reader.
• static SoType getClassTypeId (void) — gets the class type id.
• static void * createInstance (void) — creates an instance.
• static void initClass (void) — initializes the class.
• static void cleanClass (void) — cleans up the class.

🌟 Static Public Member Functions inherited from ScXMLAbstractStateElt 🌟

• 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. 🛠️
• 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 * src
• char * initial

🔐 Protected Attributes inherited from ScXMLAbstractStateElt 🔐

• char * id

🧚 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 📖

implements the <state> SCXML element. no notes. 💅

Since — Coin 3.0. ⭐

---

🍼 Constructor & Destructor Documentation 🍼

ScXMLStateElt::ScXMLStateElt (void )

Constructor. she's born. 🎀

ScXMLStateElt::~ScXMLStateElt (void ) [virtual]

Destructor. she's gone. 💀

---

🔥 Member Function Documentation 🔥

SoType ScXMLStateElt::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 ScXMLAbstractStateElt.

void ScXMLStateElt::setSrcAttribute (const char * srcstr) [virtual]

Sets the XML src attribute for the SCXML <state> element. To get the attribute value interpreted and taken action upon, you will also need to [FIXME]

not me leaving a [FIXME] in the actual docs 😭 the original really does trail off like that, bestie. that's not me being lazy, that's canon.

const char * ScXMLStateElt::getSrcAttribute (void ) const [inline]

Returns the XML src attribute for this SCXML <state> element.

void ScXMLStateElt::setInitialAttribute (const char * initialstr) [virtual]

Sets the XML initial attribute for the SCXML <state> element. If this value is set, the state should not contain an <initial> element, and vice versa.

When set, this value must be the value of a descendant an identifier for a child state.

See also ScXMLInitialElt

const char * ScXMLStateElt::getInitialAttribute (void ) const [inline]

Returns the XML initial attribute for the SCXML <state> element.

SbBool ScXMLStateElt::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. 💤

Reimplemented from ScXMLAbstractStateElt.

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

Reimplemented from ScXMLAbstractStateElt.

const ScXMLElt * ScXMLStateElt::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 ScXMLAbstractStateElt.

SbBool ScXMLStateElt::isAtomicState (void ) const

Returns TRUE if this is an "atomic state", which means that it has no sub-states but contains executable content. 👑

---

🫶 Author 🫶

Generated automatically by Doxygen for Coin from the source code. (not a human, not a bestie, just Doxygen doing her little thing 🎀)

---

okay and that's the whole page, bestie!! 💖 this was Coin 4.0.10, dated Thu Jun 25 2026 00:00:00, and yes the footer literally says ScXMLStateElt(3) again because manpages love repeating themselves. slay, go write some state machines, ily 🦋✨👑