.TH "ScXMLStateMachine" 3 "Wed May 23 2012" "Version 3.1.3" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ScXMLStateMachine \- 
.PP
Manager for processing events and setting states in SCXML structures\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/scxml/ScXMLStateMachine\&.h>\fP
.PP
Inherits \fBScXMLObject\fP\&.
.PP
Inherited by \fBSoScXMLStateMachine\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const "
.br
.ti -1c
.RI "virtual void \fBsetName\fP (const \fBSbName\fP &name)"
.br
.ti -1c
.RI "const \fBSbName\fP & \fBgetName\fP (void) const "
.br
.ti -1c
.RI "virtual void \fBsetDescription\fP (ScXMLDocument *document)"
.br
.ti -1c
.RI "const ScXMLDocument * \fBgetDescription\fP (void) const "
.br
.ti -1c
.RI "virtual void \fBinitialize\fP (void)"
.br
.ti -1c
.RI "virtual void \fBqueueEvent\fP (const \fBScXMLEvent\fP *event, SbBool dealloc=FALSE)"
.br
.ti -1c
.RI "virtual void \fBqueueEvent\fP (const \fBSbName\fP &eventid)"
.br
.ti -1c
.RI "virtual SbBool \fBprocessEventQueue\fP (void)"
.br
.ti -1c
.RI "virtual SbBool \fBisActive\fP (void) const "
.br
.ti -1c
.RI "virtual SbBool \fBisFinished\fP (void) const "
.br
.ti -1c
.RI "virtual const \fBScXMLEvent\fP * \fBgetCurrentEvent\fP (void) const "
.br
.ti -1c
.RI "virtual int \fBgetNumActiveStates\fP (void) const "
.br
.ti -1c
.RI "virtual const \fBScXMLObject\fP * \fBgetActiveState\fP (int idx) const "
.br
.ti -1c
.RI "virtual const \fBScXMLObject\fP * \fBgetState\fP (const char *identifier) const "
.br
.ti -1c
.RI "virtual void \fBaddDeleteCallback\fP (ScXMLStateMachineDeleteCB *callback, void *userdata)"
.br
.ti -1c
.RI "virtual void \fBremoveDeleteCallback\fP (ScXMLStateMachineDeleteCB *callback, void *userdata)"
.br
.ti -1c
.RI "virtual void \fBaddStateChangeCallback\fP (ScXMLStateChangeCB *callback, void *userdata)"
.br
.ti -1c
.RI "virtual void \fBremoveStateChangeCallback\fP (ScXMLStateChangeCB *callback, void *userdata)"
.br
.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
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual SbBool \fBprocessOneEvent\fP (const \fBScXMLEvent\fP *event)"
.br
.ti -1c
.RI "virtual void \fBsetCurrentEvent\fP (const \fBScXMLEvent\fP *event)"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
Manager for processing events and setting states in SCXML structures\&. 

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

.SH "Member Function Documentation"
.PP 
.SS "void ScXMLStateMachine::initialize (void)\fC [virtual]\fP"
Fire up the engine\&. 
.SS "SbBool ScXMLStateMachine::processEventQueue (void)\fC [virtual]\fP"
Recursive calling of this function will be handled by letting the recursive call return immediately, while the first call will continue processing the event queue until it is empty\&. 
.SS "SbBool ScXMLStateMachine::isActive (void) const\fC [virtual]\fP"
Returns whether the state machine is active or not\&. 
.SS "SbBool ScXMLStateMachine::isFinished (void) const\fC [virtual]\fP"
Returns whether the state machine has run to completion or not\&. 
.SS "const \fBScXMLEvent\fP * ScXMLStateMachine::getCurrentEvent (void) const\fC [virtual]\fP"
This method returns the current event during event processing, and NULL when not processing events\&.
.PP
Event processing is in special cases done with NULL as the current event, as for instance during state machine initialization\&. 
.SS "int ScXMLStateMachine::getNumActiveStates (void) const\fC [virtual]\fP"
Returns the number of active states in the state machine\&. This number should currently be 1, but in the future, when <parallel> is implemented, it can be more\&. 
.SS "const \fBScXMLObject\fP * ScXMLStateMachine::getActiveState (intidx) const\fC [virtual]\fP"
Returns the Nth active state\&. 
.SS "const \fBScXMLObject\fP * ScXMLStateMachine::getState (const char *identifier) const\fC [virtual]\fP"
Returns the state machine state object with the given identifier, or NULL if no object is found that has the given identifier\&. 
.SS "void ScXMLStateMachine::addDeleteCallback (ScXMLStateMachineDeleteCB *cb, void *userdata)\fC [virtual]\fP"
Registers a callback to be called when the state machine object is being deleted\&. 
.SS "void ScXMLStateMachine::removeDeleteCallback (ScXMLStateMachineDeleteCB *cb, void *userdata)\fC [virtual]\fP"
Unregisters a callback to be called when the state machine object is being deleted\&. 
.SS "void ScXMLStateMachine::addStateChangeCallback (ScXMLStateChangeCB *callback, void *userdata)\fC [virtual]\fP"
Registers a callback to be called when the state machine exits or enters a state\&. 
.SS "void ScXMLStateMachine::removeStateChangeCallback (ScXMLStateChangeCB *callback, void *userdata)\fC [virtual]\fP"
Unregisters a callback to be called when the state machine exits or enters a state\&. 
.SS "SbBool ScXMLStateMachine::processOneEvent (const \fBScXMLEvent\fP *event)\fC [protected]\fP, \fC [virtual]\fP"
Processes one event\&. This is an internal inner event-loop utility function\&. 
.SS "void ScXMLStateMachine::setCurrentEvent (const \fBScXMLEvent\fP *event)\fC [protected]\fP, \fC [virtual]\fP"
Sets a pointer for the event that is 'current' during event processing\&. This is an internal method, and updating the current event is handled automatically\&. 

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