.TH "SoScXMLEvent" 3 "Fri Sep 6 2024 15:32:06" "Version 4.0.3" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoScXMLEvent \- Adds an \fBSoEvent\fP holder to the \fBScXMLEvent\fP base\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <Inventor/scxml/SoScXMLEvent\&.h>\fP
.PP
Inherits \fBScXMLEvent\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 \fBsetSoEvent\fP (const \fBSoEvent\fP *soevent)"
.br
.ti -1c
.RI "virtual const \fBSoEvent\fP * \fBgetSoEvent\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBsetUpIdentifier\fP (void)"
.br
.ti -1c
.RI "virtual void \fBcopyContents\fP (const \fBScXMLEvent\fP *rhs)"
.br
.in -1c

Public Member Functions inherited from \fBScXMLEvent\fP
.in +1c
.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 \fBScXMLEvent\fP
.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 "Additional Inherited Members"


Protected Member Functions inherited from \fBScXMLEvent\fP

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 \fBScXMLEvent\fP
.in +1c
.ti -1c
.RI "\fBSbName\fP \fBname\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Adds an \fBSoEvent\fP holder to the \fBScXMLEvent\fP base\&. 

This class is part of integrating the Coin types with the SCXML subsystem\&. \fBSoScXMLEvent\fP objects are ScXMLEvents that wraps/passes an \fBSoEvent\fP to the SCXML state machine\&.

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

.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoScXMLEvent::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
Reimplemented from \fBScXMLEvent\fP\&.
.SS "void SoScXMLEvent::setSoEvent (const \fBSoEvent\fP * soevent)\fR [virtual]\fP"
This function stores a pointer to the originator \fBSoEvent\fP that caused the given event, if any\&.

.PP
The event is duplicated when set, and can be deleted immediately by the caller\&.

.PP
\fBSee also\fP
.RS 4
setUpIdentifiers 
.RE
.PP

.SS "const \fBSoEvent\fP * SoScXMLEvent::getSoEvent (void ) const\fR [virtual]\fP"
Returns the pointer to the stored \fBSoEvent\fP or NULL if no event has been stored yet\&.

.PP
\fBSee also\fP
.RS 4
\fBsetSoEvent\fP 
.RE
.PP

.SS "void SoScXMLEvent::setUpIdentifier (void )\fR [virtual]\fP"
This method updates the \fBScXMLEvent\fP event class and event identifier strings based on the set \fBSoEvent\fP object\&.

.PP
The identifiers will be cleared if no \fBSoEvent\fP object has been stored\&.

.PP
\fBSee also\fP
.RS 4
\fBsetSoEvent\fP 
.RE
.PP

.SS "void SoScXMLEvent::copyContents (const \fBScXMLEvent\fP * rhs)\fR [virtual]\fP"

.PP
Reimplemented from \fBScXMLEvent\fP\&.

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