.TH "ScXMLEvent" 3 "Tue Jun 23 2026 23:48:38" "Version 4.0.10" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ScXMLEvent \- Base class for events sent to SCXML state machines\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <Inventor/scxml/ScXMLEvent\&.h>\fP
.PP
Inherits \fBScXMLObject\fP\&.
.PP
Inherited by \fBSoScXMLEvent\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 \fBsetEventName\fP (const \fBSbName\fP &name)"
.br
.ti -1c
.RI "const \fBSbName\fP & \fBgetEventName\fP (void) const"
.br
.ti -1c
.RI "\fBScXMLEvent\fP * \fBclone\fP (void) const"
.br
.ti -1c
.RI "void \fBsetAssociation\fP (const char *key, const char *value)"
.br
.ti -1c
.RI "const char * \fBgetAssociation\fP (const char *key) const"
.br
.ti -1c
.RI "size_t \fBgetNumAssociations\fP (void) const"
.br
.ti -1c
.RI "size_t \fBgetAssociationKeys\fP (\fBSbList\fP< const char * > &keys) 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 \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 \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 "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBcopyContents\fP (const \fBScXMLEvent\fP *rhs)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBSbName\fP \fBname\fP"
.br
.in -1c
.SS "Additional Inherited Members"


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
.SH "Detailed Description"
.PP 
Base class for events sent to SCXML state machines\&. 


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

.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP ScXMLEvent::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 \fBScXMLObject\fP\&.
.PP
Reimplemented in \fBSoScXMLEvent\fP\&.
.SS "void ScXMLEvent::setEventName (const \fBSbName\fP & namearg)\fR [virtual]\fP"
This method is for setting a string that will identify this particular event, having this particular state, and can be used for event matching in the SCXML descriptions\&.

.PP
The string should, according to the specification, be a set of tokens consisting of alphanumeric characters, separated with periods (\&.)\&. This limitation is not enforced by this implementation\&. 

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