.TH "ScXMLFinalElt" 3 "Tue Jun 23 2026 23:48:38" "Version 4.0.10" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ScXMLFinalElt \- implements the <final> SCXML element\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <Inventor/scxml/ScXMLFinalElt\&.h>\fP
.PP
Inherits \fBScXMLAbstractStateElt\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const"
.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 "virtual void \fBsetOnEntry\fP (\fBScXMLOnEntryElt\fP *onentry)"
.br
.ti -1c
.RI "virtual \fBScXMLOnEntryElt\fP * \fBgetOnEntry\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBsetOnExit\fP (\fBScXMLOnExitElt\fP *onexit)"
.br
.ti -1c
.RI "virtual \fBScXMLOnExitElt\fP * \fBgetOnExit\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBcopyContents\fP (const \fBScXMLElt\fP *rhs)"
.br
.ti -1c
.RI "virtual const \fBScXMLElt\fP * \fBsearch\fP (const char *attrname, const char *attrvalue) const"
.br
.in -1c

Public Member Functions inherited from \fBScXMLAbstractStateElt\fP
.in +1c
.ti -1c
.RI "virtual void \fBsetIdAttribute\fP (const char *id)"
.br
.ti -1c
.RI "const char * \fBgetIdAttribute\fP (void) const"
.br
.ti -1c
.RI "virtual SbBool \fBhandleXMLAttributes\fP (void)"
.br
.in -1c

Public Member Functions inherited from \fBScXMLElt\fP
.in +1c
.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 "\fBScXMLElt\fP * \fBclone\fP (void) const"
.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

Public Member Functions inherited from \fBScXMLObject\fP
.in +1c
.ti -1c
.RI "SbBool \fBisOfType\fP (\fBSoType\fP type) const"
.br
.RI "Returns \fRTRUE\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 "static \fBScXMLEltReader\fP * \fBgetElementReader\fP (void)"
.br
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void * \fBcreateInstance\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.ti -1c
.RI "static void \fBcleanClass\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBScXMLAbstractStateElt\fP
.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.ti -1c
.RI "static void \fBcleanClass\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBScXMLElt\fP
.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.ti -1c
.RI "static void \fBcleanClass\fP (void)"
.br
.in -1c

Static Public Member Functions inherited from \fBScXMLObject\fP
.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&.    "
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.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 "static void \fBcleanClass\fP (void)"
.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 "Additional Inherited Members"


Static Protected Member Functions inherited from \fBScXMLElt\fP
.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

Static Protected Member Functions inherited from \fBScXMLObject\fP
.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

Protected Attributes inherited from \fBScXMLAbstractStateElt\fP
.in +1c
.ti -1c
.RI "char * \fBid\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
implements the <final> SCXML element\&. 

A <final> element takes an "id" attribute (required), and can have one child of type <onentry> and <onexit>\&.

.PP
\fBSince\fP
.RS 4
Coin 3\&.0 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP ScXMLFinalElt::getTypeId (void ) const\fR [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 \fBScXMLAbstractStateElt\fP\&.
.SS "void ScXMLFinalElt::copyContents (const \fBScXMLElt\fP * rhs)\fR [virtual]\fP"

.PP
Reimplemented from \fBScXMLAbstractStateElt\fP\&.
.SS "const \fBScXMLElt\fP * ScXMLFinalElt::search (const char * attrname, const char * attrvalue) const\fR [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 \fBScXMLAbstractStateElt\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.