Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages

vtkFunctionParser Class Reference

Parse and evaluate a mathematical expression. More...

#include <vtkFunctionParser.h>

Inheritance diagram for vtkFunctionParser:

[legend]Collaboration diagram for vtkFunctionParser:

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	IsScalarResult ()
int	IsVectorResult ()
double	GetScalarResult ()
char *	GetScalarVariableName (int i)
char *	GetVectorVariableName (int i)

void	SetFunction (const char *function)
virtual char *	GetFunction ()

double *	GetVectorResult ()
void	GetVectorResult (double result[3])

void	SetScalarVariableValue (const char *variableName, double value)
void	SetScalarVariableValue (int i, double value)

double	GetScalarVariableValue (const char *variableName)
double	GetScalarVariableValue (int i)

void	SetVectorVariableValue (const char *variableName, double xValue, double yValue, double zValue)
void	SetVectorVariableValue (const char *variableName, const double values[3])
void	SetVectorVariableValue (int i, double xValue, double yValue, double zValue)
void	SetVectorVariableValue (int i, const double values[3])

double *	GetVectorVariableValue (const char *variableName)
void	GetVectorVariableValue (const char *variableName, double value[3])
double *	GetVectorVariableValue (int i)
void	GetVectorVariableValue (int i, double value[3])

virtual int	GetNumberOfScalarVariables ()

virtual int	GetNumberOfVectorVariables ()
Static Public Methods
vtkFunctionParser *	New ()
int	IsTypeOf (const char *type)
vtkFunctionParser *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkFunctionParser ()
	~vtkFunctionParser ()
int	Parse ()
void	Evaluate ()
int	CheckSyntax ()
void	RemoveSpaces ()
int	BuildInternalFunctionStructure ()
void	BuildInternalSubstringStructure (int beginIndex, int endIndex)
void	AddInternalByte (unsigned char newByte)
int	IsSubstringCompletelyEnclosed (int beginIndex, int endIndex)
int	FindEndOfMathFunction (int beginIndex)
int	IsVariableName (int currentIndex)
int	IsElementaryOperator (int op)
int	GetMathFunctionNumber (int currentIndex)
int	GetMathFunctionStringLength (int mathFunctionNumber)
int	GetElementaryOperatorNumber (char op)
int	GetOperandNumber (int currentIndex)
int	GetVariableNameLength (int variableNumber)
int	DisambiguateOperators ()
Protected Attributes
char *	Function
int	FunctionLength
int	NumberOfScalarVariables
int	NumberOfVectorVariables
char **	ScalarVariableNames
char **	VectorVariableNames
double *	ScalarVariableValues
double **	VectorVariableValues
unsigned char *	ByteCode
int	ByteCodeSize
double *	Immediates
int	ImmediatesSize
double *	Stack
int	StackSize
int	StackPointer
vtkTimeStamp	FunctionMTime
vtkTimeStamp	ParseMTime
vtkTimeStamp	VariableMTime
vtkTimeStamp	EvaluateMTime

Detailed Description

Parse and evaluate a mathematical expression.

Date:: 2001/11/13 14:09:25

Revision:: 1.10

vtkFunctionParser is a class that takes in a mathematical expression as a char string, parses it, and evaluates it at the specified values of the variables in the input string.

Definition at line 96 of file vtkFunctionParser.h.

Constructor & Destructor Documentation

vtkFunctionParser::vtkFunctionParser ( ) [protected]

vtkFunctionParser::~vtkFunctionParser ( ) [protected]

Member Function Documentation

vtkFunctionParser* vtkFunctionParser::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.

virtual const char* vtkFunctionParser::GetClassName ( ) [virtual]

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.

int vtkFunctionParser::IsTypeOf ( const char * type ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.

virtual int vtkFunctionParser::IsA ( const char * type ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.

vtkFunctionParser* vtkFunctionParser::SafeDownCast ( vtkObject * o ) [static]

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObject.

void vtkFunctionParser::PrintSelf ( ostream & os,

vtkIndent indent

) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkObject.

void vtkFunctionParser::SetFunction ( const char * function )

Set/Get input string to evaluate.

virtual char* vtkFunctionParser::GetFunction ( ) [virtual]

Set/Get input string to evaluate.

int vtkFunctionParser::IsScalarResult ( )

Check whether the result is a scalar result. If it isn't, then either the result is a vector or an error has occurred.

int vtkFunctionParser::IsVectorResult ( )

Check whether the result is a vector result. If it isn't, then either the result is scalar or an error has occurred.

double vtkFunctionParser::GetScalarResult ( )

Get a scalar result from evaluating the input function.

double* vtkFunctionParser::GetVectorResult ( )

Get a vector result from evaluating the input function.

void vtkFunctionParser::GetVectorResult ( double result[3] ) [inline]

Get a vector result from evaluating the input function.
Definition at line 123 of file vtkFunctionParser.h.

void vtkFunctionParser::SetScalarVariableValue ( const char * variableName,

double value

)

Set the value of a scalar variable. If a variable with this name exists, then its value will be set to the new value. If there is not already a variable with this name, variableName will be added to the list of variables, and its value will be set to the new value.

void vtkFunctionParser::SetScalarVariableValue ( int i,

double value

)

Set the value of a scalar variable. If a variable with this name exists, then its value will be set to the new value. If there is not already a variable with this name, variableName will be added to the list of variables, and its value will be set to the new value.

double vtkFunctionParser::GetScalarVariableValue ( const char * variableName )

Get the value of a scalar variable.

double vtkFunctionParser::GetScalarVariableValue ( int i )

Get the value of a scalar variable.

void vtkFunctionParser::SetVectorVariableValue ( const char * variableName,

double xValue,

double yValue,

double zValue

)

Set the value of a vector variable. If a variable with this name exists, then its value will be set to the new value. If there is not already a variable with this name, variableName will be added to the list of variables, and its value will be set to the new value.

void vtkFunctionParser::SetVectorVariableValue ( const char * variableName,

const double values[3]

) [inline]

Set the value of a vector variable. If a variable with this name exists, then its value will be set to the new value. If there is not already a variable with this name, variableName will be added to the list of variables, and its value will be set to the new value.
Definition at line 150 of file vtkFunctionParser.h.

void vtkFunctionParser::SetVectorVariableValue ( int i,

double xValue,

double yValue,

double zValue

)

Set the value of a vector variable. If a variable with this name exists, then its value will be set to the new value. If there is not already a variable with this name, variableName will be added to the list of variables, and its value will be set to the new value.

void vtkFunctionParser::SetVectorVariableValue ( int i,

const double values[3]

) [inline]

Set the value of a vector variable. If a variable with this name exists, then its value will be set to the new value. If there is not already a variable with this name, variableName will be added to the list of variables, and its value will be set to the new value.
Definition at line 155 of file vtkFunctionParser.h.

double* vtkFunctionParser::GetVectorVariableValue ( const char * variableName )

Get the value of a vector variable.

void vtkFunctionParser::GetVectorVariableValue ( const char * variableName,

double value[3]

) [inline]

Get the value of a vector variable.
Definition at line 162 of file vtkFunctionParser.h.

double* vtkFunctionParser::GetVectorVariableValue ( int i )

Get the value of a vector variable.

void vtkFunctionParser::GetVectorVariableValue ( int i,

double value[3]

) [inline]

Get the value of a vector variable.
Definition at line 166 of file vtkFunctionParser.h.

virtual int vtkFunctionParser::GetNumberOfScalarVariables ( ) [virtual]

Get the number of scalar variables.

virtual int vtkFunctionParser::GetNumberOfVectorVariables ( ) [virtual]

Get the number of vector variables.

char* vtkFunctionParser::GetScalarVariableName ( int i )

Get the ith scalar variable name.

char* vtkFunctionParser::GetVectorVariableName ( int i )

Get the ith vector variable name.

int vtkFunctionParser::Parse ( ) [protected]

void vtkFunctionParser::Evaluate ( ) [protected]

int vtkFunctionParser::CheckSyntax ( ) [protected]

void vtkFunctionParser::RemoveSpaces ( ) [protected]

int vtkFunctionParser::BuildInternalFunctionStructure ( ) [protected]

void vtkFunctionParser::BuildInternalSubstringStructure ( int beginIndex,

int endIndex

) [protected]

void vtkFunctionParser::AddInternalByte ( unsigned char newByte ) [protected]

int vtkFunctionParser::IsSubstringCompletelyEnclosed ( int beginIndex,

int endIndex

) [protected]

int vtkFunctionParser::FindEndOfMathFunction ( int beginIndex ) [protected]

int vtkFunctionParser::IsVariableName ( int currentIndex ) [protected]

int vtkFunctionParser::IsElementaryOperator ( int op ) [protected]

int vtkFunctionParser::GetMathFunctionNumber ( int currentIndex ) [protected]

int vtkFunctionParser::GetMathFunctionStringLength ( int mathFunctionNumber ) [protected]

int vtkFunctionParser::GetElementaryOperatorNumber ( char op ) [protected]

int vtkFunctionParser::GetOperandNumber ( int currentIndex ) [protected]

int vtkFunctionParser::GetVariableNameLength ( int variableNumber ) [protected]

int vtkFunctionParser::DisambiguateOperators ( ) [protected]

Member Data Documentation

char* vtkFunctionParser::Function [protected]

Definition at line 215 of file vtkFunctionParser.h.

int vtkFunctionParser::FunctionLength [protected]

Definition at line 216 of file vtkFunctionParser.h.

int vtkFunctionParser::NumberOfScalarVariables [protected]

Definition at line 217 of file vtkFunctionParser.h.

int vtkFunctionParser::NumberOfVectorVariables [protected]

Definition at line 218 of file vtkFunctionParser.h.

char** vtkFunctionParser::ScalarVariableNames [protected]

Definition at line 219 of file vtkFunctionParser.h.

char** vtkFunctionParser::VectorVariableNames [protected]

Definition at line 220 of file vtkFunctionParser.h.

double* vtkFunctionParser::ScalarVariableValues [protected]

Definition at line 221 of file vtkFunctionParser.h.

double** vtkFunctionParser::VectorVariableValues [protected]

Definition at line 222 of file vtkFunctionParser.h.

unsigned char* vtkFunctionParser::ByteCode [protected]

Definition at line 223 of file vtkFunctionParser.h.

int vtkFunctionParser::ByteCodeSize [protected]

Definition at line 224 of file vtkFunctionParser.h.

double* vtkFunctionParser::Immediates [protected]

Definition at line 225 of file vtkFunctionParser.h.

int vtkFunctionParser::ImmediatesSize [protected]

Definition at line 226 of file vtkFunctionParser.h.

double* vtkFunctionParser::Stack [protected]

Definition at line 227 of file vtkFunctionParser.h.

int vtkFunctionParser::StackSize [protected]

Definition at line 228 of file vtkFunctionParser.h.

int vtkFunctionParser::StackPointer [protected]

Definition at line 229 of file vtkFunctionParser.h.

vtkTimeStamp vtkFunctionParser::FunctionMTime [protected]

Definition at line 231 of file vtkFunctionParser.h.

vtkTimeStamp vtkFunctionParser::ParseMTime [protected]

Definition at line 232 of file vtkFunctionParser.h.

vtkTimeStamp vtkFunctionParser::VariableMTime [protected]

Definition at line 233 of file vtkFunctionParser.h.

vtkTimeStamp vtkFunctionParser::EvaluateMTime [protected]

Definition at line 234 of file vtkFunctionParser.h.

The documentation for this class was generated from the following file:

Common/vtkFunctionParser.h

Generated on Thu Mar 28 14:29:34 2002 for VTK by

vtkFunctionParser Class Reference

Public Methods

Static Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation