ScXMLStateMachine (3)

#include <Inventor/scxml/ScXMLStateMachine.h>

Inherits ScXMLEventTarget.

Inherited by SoScXMLStateMachine.

Public Member Functions

virtual SoType getTypeId (void) const

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting. virtual void setName (const SbName &name)

const SbName & getName (void) const

virtual void setDescription (ScXMLDocument *document)

const ScXMLDocument * getDescription (void) const

virtual void setSessionId (const SbName &sessionid)

const SbName & getSessionId (void) const

virtual void initialize (void)

virtual SbBool isActive (void) const

virtual SbBool isFinished (void) const

virtual int getNumActiveStates (void) const

virtual const ScXMLElt * getActiveState (int idx) const

virtual void addDeleteCallback (ScXMLStateMachineDeleteCB *callback, void *userdata)

virtual void removeDeleteCallback (ScXMLStateMachineDeleteCB *callback, void *userdata)

virtual void addStateChangeCallback (ScXMLStateChangeCB *callback, void *userdata)

virtual void removeStateChangeCallback (ScXMLStateChangeCB *callback, void *userdata)

virtual void setVariable (const char *name, const char *value)

virtual const char * getVariable (const char *name) const

virtual void setLogLevel (int loglevel)

int getLogLevel (void) const

virtual void setEvaluator (ScXMLEvaluator *evaluator)

ScXMLEvaluator * getEvaluator (void) const

SbBool isModuleEnabled (const char *modulename) const

int getNumEnabledModules (void) const

const char * getEnabledModuleName (int idx) const

void setEnabledModulesList (const SbList< const char * > &modulenames)

Static Public Member Functions

static SoType getClassTypeId (void)

static void * createInstance (void)

static void initClass (void)

static void cleanClass (void)

static ScXMLStateMachine * getStateMachineForSessionId (const SbName &sessionid)

Protected Member Functions

virtual SbBool processOneEvent (const ScXMLEvent *event)

Additional Inherited Members

Manager for processing events and setting states in SCXML structures.

Since:

Coin 3.0

\fBSoType\fP ScXMLStateMachine::getTypeId (void) const\fC [virtual]\fP

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting.

See also:

SoBase::getTypeId() const

Implements ScXMLEventTarget.

Reimplemented in SoScXMLStateMachine.

void ScXMLStateMachine::setSessionId (const \fBSbName\fP &sessionidarg)\fC [virtual]\fP

This sets the session identifier for the state machine. Using this is optional, since state machines are already assigned unique session ids at construction-time.

const \fBSbName\fP & ScXMLStateMachine::getSessionId (void) const

Returns the session identifier string for the state machine.

void ScXMLStateMachine::initialize (void)\fC [virtual]\fP

Fire up the engine.

SbBool ScXMLStateMachine::isActive (void) const\fC [virtual]\fP

Returns whether the state machine is active or not.

SbBool ScXMLStateMachine::isFinished (void) const\fC [virtual]\fP

Returns whether the state machine has run to completion or not.

int ScXMLStateMachine::getNumActiveStates (void) const\fC [virtual]\fP

This method returns the current event during event processing, and NULL when not processing events.

Event processing is in special cases done with NULL as the current event, as for instance during state machine initialization.

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.

const \fBScXMLElt\fP * ScXMLStateMachine::getActiveState (intidx) const\fC [virtual]\fP

Returns the Nth active state.

void ScXMLStateMachine::addDeleteCallback (ScXMLStateMachineDeleteCB *cb, void *userdata)\fC [virtual]\fP

Registers a callback to be called when the state machine object is being deleted.

void ScXMLStateMachine::removeDeleteCallback (ScXMLStateMachineDeleteCB *cb, void *userdata)\fC [virtual]\fP

Unregisters a callback to be called when the state machine object is being deleted.

void ScXMLStateMachine::addStateChangeCallback (\fBScXMLStateChangeCB\fP *callback, void *userdata)\fC [virtual]\fP

Registers a callback to be called when the state machine exits or enters a state.

void ScXMLStateMachine::removeStateChangeCallback (\fBScXMLStateChangeCB\fP *callback, void *userdata)\fC [virtual]\fP

Unregisters a callback to be called when the state machine exits or enters a state.

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.

Reimplemented from ScXMLEventTarget.

Generated automatically by Doxygen for Coin from the source code.