ScXMLStateElt(3)

NAME
ScXMLStateElt - implements the <state> SCXML element.

SYNOPSIS

#include <Inventor/scxml/ScXMLStateElt.h>

Inherits ScXMLAbstractStateElt.

  Public Member Functions
virtual SoType getTypeId (void) const
Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and 'downward' casting.
ScXMLStateElt (void)
virtual ~ScXMLStateElt (void)
virtual void setSrcAttribute (const char *src)
const char * getSrcAttribute (void) const
virtual void setInitialAttribute (const char *initial)
const char * getInitialAttribute (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 setOnEntry (ScXMLOnEntryElt *onentry)
virtual ScXMLOnEntryElt * getOnEntry (void) const
virtual void setOnExit (ScXMLOnExitElt *onexit)
virtual ScXMLOnExitElt * getOnExit (void) const
virtual int getNumTransitions (void) const
virtual ScXMLTransitionElt * getTransition (int idx) const
virtual void addTransition (ScXMLTransitionElt *transition)
virtual void removeTransition (ScXMLTransitionElt *transition)
virtual void clearAllTransitions (void)
virtual void setInitial (ScXMLInitialElt *initial)
virtual ScXMLInitialElt * getInitial (void) const
virtual int getNumStates (void) const
virtual ScXMLStateElt * getState (int idx) const
virtual void addState (ScXMLStateElt *state)
virtual void removeState (ScXMLStateElt *state)
virtual void clearAllStates (void)
virtual int getNumParallels (void) const
virtual ScXMLParallelElt * getParallel (int idx) const
virtual void addParallel (ScXMLParallelElt *state)
virtual void removeParallel (ScXMLParallelElt *state)
virtual void clearAllParallels (void)
virtual int getNumFinals (void) const
virtual ScXMLFinalElt * getFinal (int idx) const
virtual void addFinal (ScXMLFinalElt *state)
virtual void removeFinal (ScXMLFinalElt *state)
virtual void clearAllFinals (void)
virtual int getNumHistories (void) const
virtual ScXMLHistoryElt * getHistory (int idx) const
virtual void addHistory (ScXMLHistoryElt *history)
virtual void removeHistory (ScXMLHistoryElt *history)
virtual void clearAllHistories (void)
virtual int getNumAnchors (void) const
virtual ScXMLAnchorElt * getAnchor (int idx) const
virtual void addAnchor (ScXMLAnchorElt *anchor)
virtual void removeAnchor (ScXMLAnchorElt *anchor)
virtual void clearAllAnchors (void)
virtual void setDataModel (ScXMLDataModelElt *datamodel)
virtual ScXMLDataModelElt * getDataModel (void) const
SbBool isAtomicState (void) const

  Static Public Member Functions
static ScXMLEltReader * getElementReader (void)
static SoType getClassTypeId (void)
static void * createInstance (void)
static void initClass (void)
static void cleanClass (void)

  Protected Attributes
char * src
char * initial

  Additional Inherited Members

Detailed Description

implements the <state> SCXML element.

Since
    Coin 3.0

Constructor & Destructor Documentation

  ScXMLStateElt::ScXMLStateElt (void)
Constructor.

  ScXMLStateElt::~ScXMLStateElt (void) [virtual]
Destructor.

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]

  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.

  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.