.TH "ScXMLEvaluator" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ScXMLEvaluator \- defines an interface for profile-dependent evaluators\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/scxml/ScXMLEvaluator\&.h>\fP
.PP
Inherits \fBScXMLObject\fP\&.
.PP
Inherited by \fBScXMLCoinEvaluator\fP, \fBScXMLECMAScriptEvaluator\fP, \fBScXMLMinimumEvaluator\fP, and \fBScXMLXPathEvaluator\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP =0"
.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 \fBsetStateMachine\fP (\fBScXMLStateMachine\fP *\fBsm\fP)"
.br
.ti -1c
.RI "\fBScXMLStateMachine\fP * \fBgetStateMachine\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBScXMLDataObj\fP * \fBevaluate\fP (\fBconst\fP char *expression) \fBconst\fP =0"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBsetAtLocation\fP (\fBconst\fP char *location, \fBScXMLDataObj\fP *\fBobj\fP)=0"
.br
.ti -1c
.RI "\fBvirtual\fP \fBScXMLDataObj\fP * \fBlocate\fP (\fBconst\fP char *location) \fBconst\fP =0"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBclearTemporaryVariables\fP (\fBvoid\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 \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 \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 
defines an interface for profile-dependent evaluators\&. 


.PP
\fBSince\fP
.RS 4
Coin \fB3\&.1\fP 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "\fBvirtual\fP \fBSoType\fP ScXMLEvaluator::getTypeId (\fBvoid\fP) const\fC [pure 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
Implemented in \fBScXMLCoinEvaluator\fP, \fBScXMLECMAScriptEvaluator\fP, \fBScXMLMinimumEvaluator\fP, and \fBScXMLXPathEvaluator\fP\&.
.SS "\fBvoid\fP ScXMLEvaluator::setStateMachine (\fBScXMLStateMachine\fP * sm)\fC [virtual]\fP"
Override to perform actions when installed on a state machine\&. 
.PP
Reimplemented in \fBScXMLMinimumEvaluator\fP, and \fBScXMLCoinEvaluator\fP\&.
.SS "\fBScXMLDataObj\fP * ScXMLEvaluator::evaluate (\fBconst\fP char * expression) const\fC [pure virtual]\fP"

.PP
Implemented in \fBScXMLMinimumEvaluator\fP\&.
.SS "\fBvirtual\fP SbBool ScXMLEvaluator::setAtLocation (\fBconst\fP char * location, \fBScXMLDataObj\fP * obj)\fC [pure virtual]\fP"

.PP
Implemented in \fBScXMLMinimumEvaluator\fP\&.
.SS "\fBScXMLDataObj\fP * ScXMLEvaluator::locate (\fBconst\fP char * location) const\fC [pure virtual]\fP"

.PP
Implemented in \fBScXMLMinimumEvaluator\fP\&.
.SS "\fBvoid\fP ScXMLEvaluator::clearTemporaryVariables (\fBvoid\fP)\fC [virtual]\fP"
Does nothing - overridden in derived classes\&.
.PP
The intention of this function is to clear out temporary variables that have the scope of only one event being processed by the scxml state machine\&. 
.PP
Reimplemented in \fBScXMLCoinEvaluator\fP, and \fBScXMLMinimumEvaluator\fP\&.

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