Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://bitbucket.org/Coin3D/
http://www.kongsberg.com/kogt/
ScXMLAbstractStateElt Class Referenceabstract

abstract base class for the SCXML 'state' elements. More...

#include <Inventor/scxml/ScXMLAbstractStateElt>

Inheritance diagram for ScXMLAbstractStateElt:
ScXMLElt ScXMLObject ScXMLFinalElt ScXMLParallelElt ScXMLStateElt

Public Member Functions

virtual SoType getTypeId (void) const =0
 Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. More...
 
virtual void setIdAttribute (const char *id)
 
const char * getIdAttribute (void) const
 
virtual SbBool handleXMLAttributes (void)
 
virtual void copyContents (const ScXMLElt *rhs)
 
virtual const ScXMLEltsearch (const char *attrname, const char *attrvalue) const
 
- Public Member Functions inherited from ScXMLElt
void setXMLAttribute (const char *attribute, const char *value)
 
const char * getXMLAttribute (const char *attribute) const
 
ScXMLEltclone (void) const
 
virtual void setContainer (ScXMLElt *container)
 
ScXMLEltgetContainer (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. More...
 

Static Public Member Functions

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. More...
 
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. More...
 
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 typesystem.
 

Protected Attributes

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

abstract base class for the SCXML 'state' elements.

Since
Coin 3.1

Member Function Documentation

◆ getTypeId()

virtual SoType ScXMLAbstractStateElt::getTypeId ( void  ) const
pure virtual

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

See also
SoBase::getTypeId() const

Implements ScXMLElt.

Implemented in ScXMLParallelElt, ScXMLStateElt, and ScXMLFinalElt.

◆ handleXMLAttributes()

SbBool ScXMLAbstractStateElt::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 ScXMLElt.

Reimplemented in ScXMLStateElt, and ScXMLParallelElt.

◆ search()

const ScXMLElt * ScXMLAbstractStateElt::search ( const char *  attrname,
const char *  attrvalue 
) const
virtual

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

Returns NULL if nothing was found.

This function needs to be reimplemented to traverse child elements.

Reimplemented from ScXMLElt.

Reimplemented in ScXMLStateElt, ScXMLParallelElt, and ScXMLFinalElt.


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