.TH "ScXMLElt" 3 "Sat Oct 12 2013" "Version 4.0.0a" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME ScXMLElt \- .PP base class for all SCXML elements\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBScXMLObject\fP\&. .PP Inherited by \fBScXMLAbstractStateElt\fP, \fBScXMLAnchorElt\fP, \fBScXMLContentElt\fP, \fBScXMLDataElt\fP, \fBScXMLDataModelElt\fP, \fBScXMLExecutableElt\fP, \fBScXMLFinalizeElt\fP, \fBScXMLHistoryElt\fP, \fBScXMLInitialElt\fP, ScXMLOnEntryElt, ScXMLOnExitElt, \fBScXMLParamElt\fP, \fBScXMLScxmlElt\fP, and \fBScXMLTransitionElt\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const =0" .br .RI "\fIReturns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for run-time type checking and 'downward' casting\&. \fP" .ti -1c .RI "void \fBsetXMLAttribute\fP (const char *attribute, const char *value)" .br .ti -1c .RI "const char * \fBgetXMLAttribute\fP (const char *attribute) const " .br .ti -1c .RI "virtual SbBool \fBhandleXMLAttributes\fP (void)" .br .ti -1c .RI "virtual const \fBScXMLElt\fP * \fBsearch\fP (const char *attrname, const char *attrvalue) const " .br .ti -1c .RI "\fBScXMLElt\fP * \fBclone\fP (void) const " .br .ti -1c .RI "virtual void \fBcopyContents\fP (const \fBScXMLElt\fP *rhs)" .br .ti -1c .RI "virtual void \fBsetContainer\fP (\fBScXMLElt\fP *container)" .br .ti -1c .RI "\fBScXMLElt\fP * \fBgetContainer\fP (void) const " .br .ti -1c .RI "SbBool \fBisContainedIn\fP (const \fBScXMLElt\fP *object) const " .br .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)" .br .RI "\fIThis static method returns the \fBSoType\fP object associated with objects of this class\&. \fP" .ti -1c .RI "static void \fBinitClass\fP (void)" .br .RI "\fISets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. \fP" .ti -1c .RI "static void \fBcleanClass\fP (void)" .br .RI "\fIDoes the opposite of initClass, deallocates any class specific resources and resets the class to an uninitialized state with respect to the Coin typesystem\&. \fP" .in -1c .SS "Static Protected Member Functions" .in +1c .ti -1c .RI "static void \fBregisterClassType\fP (const char *xmlns, const char *classname, \fBSoType\fP type)" .br .ti -1c .RI "static void \fBregisterInvokeClassType\fP (const char *xmlns, const char *targettype, const char *source, \fBSoType\fP type)" .br .in -1c .SH "Detailed Description" .PP base class for all SCXML elements\&. This is a common base class for all SCXML document element classes\&. It manages XML attributes at the generic level, has utilities for checking document containment, and provides some infrastructure hooks\&. .PP \fBSince:\fP .RS 4 2008-11-01 .RE .PP .SH "Member Function Documentation" .PP .SS "\fBSoType\fP ScXMLElt::getClassTypeId (void)\fC [static]\fP" .PP This static method returns the \fBSoType\fP object associated with objects of this class\&. \fBSee Also:\fP .RS 4 \fBSoBase::getClassTypeId\fP .RE .PP .PP Reimplemented from \fBScXMLObject\fP\&. .PP Reimplemented in \fBScXMLParallelElt\fP, \fBScXMLStateElt\fP, \fBScXMLScxmlElt\fP, \fBScXMLInvokeElt\fP, \fBScXMLEventElt\fP, \fBScXMLIfElt\fP, \fBScXMLSendElt\fP, \fBScXMLTransitionElt\fP, \fBScXMLDataElt\fP, \fBScXMLDataModelElt\fP, \fBScXMLExecutableElt\fP, \fBScXMLFinalElt\fP, \fBScXMLHistoryElt\fP, \fBScXMLInitialElt\fP, \fBScXMLAbstractStateElt\fP, \fBScXMLAnchorElt\fP, \fBScXMLAssignElt\fP, \fBScXMLContentElt\fP, \fBScXMLElseElt\fP, \fBScXMLElseIfElt\fP, \fBScXMLFinalizeElt\fP, \fBScXMLLogElt\fP, \fBScXMLParamElt\fP, \fBScXMLScriptElt\fP, and \fBScXMLValidateElt\fP\&. .SS "virtual \fBSoType\fP ScXMLElt::getTypeId (void) const\fC [pure virtual]\fP" .PP Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for run-time type checking and 'downward' casting\&. \fBSee Also:\fP .RS 4 \fBSoBase::getTypeId() const\fP .RE .PP .PP Implements \fBScXMLObject\fP\&. .PP Implemented in \fBScXMLParallelElt\fP, \fBScXMLStateElt\fP, \fBScXMLScxmlElt\fP, \fBScXMLInvokeElt\fP, \fBScXMLEventElt\fP, \fBScXMLIfElt\fP, \fBScXMLSendElt\fP, \fBScXMLTransitionElt\fP, \fBScXMLDataElt\fP, \fBScXMLDataModelElt\fP, \fBScXMLExecutableElt\fP, \fBScXMLFinalElt\fP, \fBScXMLHistoryElt\fP, \fBScXMLInitialElt\fP, \fBScXMLAbstractStateElt\fP, \fBScXMLAnchorElt\fP, \fBScXMLAssignElt\fP, \fBScXMLContentElt\fP, \fBScXMLElseElt\fP, \fBScXMLElseIfElt\fP, \fBScXMLFinalizeElt\fP, \fBScXMLLogElt\fP, \fBScXMLParamElt\fP, \fBScXMLScriptElt\fP, and \fBScXMLValidateElt\fP\&. .SS "void ScXMLElt::initClass (void)\fC [static]\fP" .PP Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. \fBSee Also:\fP .RS 4 \fBSoBase::initClass()\fP .RE .PP .PP Reimplemented from \fBScXMLObject\fP\&. .PP Reimplemented in \fBScXMLParallelElt\fP, \fBScXMLStateElt\fP, \fBScXMLScxmlElt\fP, \fBScXMLInvokeElt\fP, \fBScXMLEventElt\fP, \fBScXMLIfElt\fP, \fBScXMLSendElt\fP, \fBScXMLDataElt\fP, \fBScXMLDataModelElt\fP, \fBScXMLExecutableElt\fP, \fBScXMLFinalElt\fP, \fBScXMLHistoryElt\fP, \fBScXMLTransitionElt\fP, \fBScXMLInitialElt\fP, \fBScXMLAbstractStateElt\fP, \fBScXMLAnchorElt\fP, \fBScXMLAssignElt\fP, \fBScXMLContentElt\fP, \fBScXMLElseElt\fP, \fBScXMLElseIfElt\fP, \fBScXMLFinalizeElt\fP, \fBScXMLLogElt\fP, \fBScXMLParamElt\fP, \fBScXMLScriptElt\fP, and \fBScXMLValidateElt\fP\&. .SS "void ScXMLElt::setXMLAttribute (const char *attribute, const char *value)" This method associates a value with an attribute name\&. This is used for parameter passing while reading by the SCXML reader, but can be used as a general-purpose attribute dictionary outside of that\&. .PP If NULL is passed as the value, the attribute is removed\&. .SS "const char * ScXMLElt::getXMLAttribute (const char *attribute) const" This method returns the string value set for an attribute, or NULL if not set\&. .SS "SbBool ScXMLElt::handleXMLAttributes (void)\fC [virtual]\fP" 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\&. .PP \fBReturns:\fP .RS 4 TRUE if the attributes are ok, and FALSE on error\&. .RE .PP This base class implementation does nothing and just returns TRUE\&. .PP Reimplemented in \fBScXMLScxmlElt\fP, \fBScXMLSendElt\fP, \fBScXMLStateElt\fP, \fBScXMLInvokeElt\fP, \fBScXMLParallelElt\fP, \fBScXMLTransitionElt\fP, \fBScXMLDataElt\fP, \fBScXMLAssignElt\fP, \fBScXMLLogElt\fP, \fBScXMLHistoryElt\fP, \fBScXMLAnchorElt\fP, \fBScXMLEventElt\fP, \fBScXMLIfElt\fP, \fBScXMLParamElt\fP, \fBScXMLValidateElt\fP, \fBScXMLDataModelElt\fP, \fBScXMLAbstractStateElt\fP, and \fBScXMLElseIfElt\fP\&. .SS "const \fBScXMLElt\fP * ScXMLElt::search (const char *attrname, const char *attrvalue) const\fC [virtual]\fP" This method searches the SCXML structure for an element with the given attributevalue for the given attribute\&. .PP Returns NULL if nothing was found\&. .PP This function needs to be reimplemented to traverse child elements\&. .PP Reimplemented in \fBScXMLScxmlElt\fP, \fBScXMLSendElt\fP, \fBScXMLStateElt\fP, \fBScXMLInvokeElt\fP, \fBScXMLParallelElt\fP, \fBScXMLTransitionElt\fP, \fBScXMLDataElt\fP, \fBScXMLDataModelElt\fP, \fBScXMLAssignElt\fP, \fBScXMLLogElt\fP, \fBScXMLHistoryElt\fP, \fBScXMLAnchorElt\fP, \fBScXMLEventElt\fP, \fBScXMLFinalElt\fP, \fBScXMLIfElt\fP, \fBScXMLParamElt\fP, \fBScXMLValidateElt\fP, \fBScXMLAbstractStateElt\fP, \fBScXMLElseIfElt\fP, and \fBScXMLInitialElt\fP\&. .SS "\fBScXMLElt\fP * ScXMLElt::clone (void) const" Returns a deep copy of the given SCXML element\&. .SS "void ScXMLElt::setContainer (\fBScXMLElt\fP *container)\fC [virtual]\fP" Set the pointer to the parent \fBScXML\fP object\&. .SS "SbBool ScXMLElt::isContainedIn (const \fBScXMLElt\fP *element) const" This method returns TRUE if the object is contained within the given \fIobject\fP argument\&. Also if they are the same, TRUE will be returned\&. Otherwise, FALSE is retured\&. .SS "static void ScXMLElt::registerClassType (const char *xmlns, const char *classname, \fBSoType\fPtype)\fC [static]\fP, \fC [protected]\fP" Internal method\&. Friendly forwarding for \fBScXMLObject\fP subclasses\&. .PP Reimplemented from \fBScXMLObject\fP\&. .SS "static void ScXMLElt::registerInvokeClassType (const char *xmlns, const char *targettype, const char *source, \fBSoType\fPtype)\fC [static]\fP, \fC [protected]\fP" Internal method\&. Friendly forwarding for \fBScXMLObject\fP subclasses\&. .PP Reimplemented from \fBScXMLObject\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.