.TH "ScXMLInitialElt" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ScXMLInitialElt \- implements the <initial> SCXML element\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/scxml/ScXMLInitialElt\&.h>\fP
.PP
Inherits \fBScXMLElt\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP"
.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 \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
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsetTransition\fP (\fBScXMLTransitionElt\fP *\fBtransition\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBScXMLTransitionElt\fP * \fBgetTransition\fP (\fBvoid\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 "\fBvirtual\fP SbBool \fBhandleXMLAttributes\fP (\fBvoid\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 \fBScXMLEltReader\fP * \fBgetElementReader\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP * \fBcreateInstance\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 "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 
implements the <initial> SCXML element\&. 

An <initial> element has no attributes, and should contain one conditionless <transition> element with a target attribute that identifies a descendant state element of the parent state element\&.
.PP
\fBSince\fP
.RS 4
Coin \fB3\&.0\fP 
.RE
.PP

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

.PP
Reimplemented from \fBScXMLElt\fP\&.
.SS "\fBconst\fP \fBScXMLElt\fP * ScXMLInitialElt::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\&.

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