.TH "ScXMLAbstractStateElt" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME ScXMLAbstractStateElt \- abstract base class for the SCXML 'state' elements\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBScXMLElt\fP\&. .PP Inherited by \fBScXMLFinalElt\fP, \fBScXMLParallelElt\fP, and \fBScXMLStateElt\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP =0" .br .RI "Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and 'downward' casting\&. " .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBsetIdAttribute\fP (\fBconst\fP char *id)" .br .ti -1c .RI "\fBconst\fP char * \fBgetIdAttribute\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP SbBool \fBhandleXMLAttributes\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBcopyContents\fP (\fBconst\fP \fBScXMLElt\fP *rhs)" .br .ti -1c .RI "\fBvirtual\fP \fBconst\fP \fBScXMLElt\fP * \fBsearch\fP (\fBconst\fP char *\fBattrname\fP, \fBconst\fP char *\fBattrvalue\fP) \fBconst\fP" .br .in -1c Public Member Functions inherited from \fBScXMLElt\fP .in +1c .ti -1c .RI "\fBvoid\fP \fBsetXMLAttribute\fP (\fBconst\fP char *\fBattribute\fP, \fBconst\fP char *value)" .br .ti -1c .RI "\fBconst\fP char * \fBgetXMLAttribute\fP (\fBconst\fP char *\fBattribute\fP) \fBconst\fP" .br .ti -1c .RI "\fBScXMLElt\fP * \fBclone\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBsetContainer\fP (\fBScXMLElt\fP *container)" .br .ti -1c .RI "\fBScXMLElt\fP * \fBgetContainer\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "SbBool \fBisContainedIn\fP (\fBconst\fP \fBScXMLElt\fP *\fBobject\fP) \fBconst\fP" .br .in -1c Public Member Functions inherited from \fBScXMLObject\fP .in +1c .ti -1c .RI "SbBool \fBisOfType\fP (\fBSoType\fP type) \fBconst\fP" .br .RI "Returns \fCTRUE\fP if the type of this object is either of the same type or inherited from \fItype\fP\&. " .in -1c .SS "Static Public Member Functions" .in +1c .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBcleanClass\fP (\fBvoid\fP)" .br .in -1c Static Public Member Functions inherited from \fBScXMLElt\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBcleanClass\fP (\fBvoid\fP)" .br .in -1c Static Public Member Functions inherited from \fBScXMLObject\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)" .br .RI "This static method returns the \fBSoType\fP object associated with objects of this class\&. " .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)" .br .RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. " .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBcleanClass\fP (\fBvoid\fP)" .br .RI "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\&. " .in -1c .SS "Protected Attributes" .in +1c .ti -1c .RI "char * \fBid\fP" .br .in -1c .SS "Additional Inherited Members" Static Protected Member Functions inherited from \fBScXMLElt\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBregisterClassType\fP (\fBconst\fP char *xmlns, \fBconst\fP char *\fBclassname\fP, \fBSoType\fP type)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBregisterInvokeClassType\fP (\fBconst\fP char *xmlns, \fBconst\fP char *targettype, \fBconst\fP char *source, \fBSoType\fP type)" .br .in -1c Static Protected Member Functions inherited from \fBScXMLObject\fP .in +1c .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBregisterClassType\fP (\fBconst\fP char *xmlns, \fBconst\fP char *\fBclassname\fP, \fBSoType\fP type)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBregisterInvokeClassType\fP (\fBconst\fP char *xmlns, \fBconst\fP char *targettype, \fBconst\fP char *source, \fBSoType\fP type)" .br .in -1c .SH "Detailed Description" .PP abstract base class for the SCXML 'state' elements\&. .PP \fBSince\fP .RS 4 Coin \fB3\&.1\fP .RE .PP .SH "Member Function Documentation" .PP .SS "\fBvirtual\fP \fBSoType\fP ScXMLAbstractStateElt::getTypeId (\fBvoid\fP) const\fC [pure virtual]\fP" .PP Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and 'downward' casting\&. .PP \fBSee also\fP .RS 4 \fBSoBase::getTypeId() const\fP .RE .PP .PP Implements \fBScXMLElt\fP\&. .PP Implemented in \fBScXMLFinalElt\fP, \fBScXMLParallelElt\fP, and \fBScXMLStateElt\fP\&. .SS "SbBool ScXMLAbstractStateElt::handleXMLAttributes (\fBvoid\fP)\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 from \fBScXMLElt\fP\&. .PP Reimplemented in \fBScXMLParallelElt\fP, and \fBScXMLStateElt\fP\&. .SS "\fBvoid\fP ScXMLAbstractStateElt::copyContents (\fBconst\fP \fBScXMLElt\fP * rhs)\fC [virtual]\fP" .PP Reimplemented from \fBScXMLElt\fP\&. .SS "\fBconst\fP \fBScXMLElt\fP * ScXMLAbstractStateElt::search (\fBconst\fP char * attrname, \fBconst\fP char * attrvalue) const\fC [virtual]\fP" This method searches the SCXML structure for an element with the given attribute value for the given attribute\&. .PP Returns NULL if nothing was found\&. .PP This function needs to be reimplemented to traverse child elements\&. .PP Reimplemented from \fBScXMLElt\fP\&. .PP Reimplemented in \fBScXMLFinalElt\fP, \fBScXMLParallelElt\fP, and \fBScXMLStateElt\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.