ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkFunctionParser Class Reference

vtkFunctionParser - Parse and evaluate a mathematical expression More...

Inheritance diagram for Kitware.VTK.vtkFunctionParser:
[legend]
Collaboration diagram for Kitware.VTK.vtkFunctionParser:
[legend]

List of all members.

Public Member Functions

 vtkFunctionParser (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkFunctionParser ()
 Undocumented Block.
virtual string GetFunction ()
 Set/Get input string to evaluate.
virtual int GetNumberOfScalarVariables ()
 Get the number of scalar variables.
virtual int GetNumberOfVectorVariables ()
 Get the number of vector variables.
virtual int GetReplaceInvalidValues ()
 When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported.
virtual double GetReplacementValue ()
 When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported.
double GetScalarResult ()
 Get a scalar result from evaluating the input function.
string GetScalarVariableName (int i)
 Get the ith scalar variable name.
double GetScalarVariableValue (string variableName)
 Get the value of a scalar variable.
double GetScalarVariableValue (int i)
 Get the value of a scalar variable.
double[] GetVectorResult ()
 Get a vector result from evaluating the input function.
void GetVectorResult (IntPtr result)
 Get a vector result from evaluating the input function.
string GetVectorVariableName (int i)
 Get the ith vector variable name.
double[] GetVectorVariableValue (string variableName)
 Get the value of a vector variable.
void GetVectorVariableValue (string variableName, IntPtr value)
 Get the value of a vector variable.
double[] GetVectorVariableValue (int i)
 Get the value of a vector variable.
void GetVectorVariableValue (int i, IntPtr value)
 Get the value of a vector variable.
override int IsA (string type)
 Undocumented Block.
int 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 IsVectorResult ()
 Check whether the result is a vector result. If it isn't, then either the result is scalar or an error has occurred.
new vtkFunctionParser NewInstance ()
 Undocumented Block.
void RemoveAllVariables ()
 Remove all the current variables.
void RemoveScalarVariables ()
 Remove all the scalar variables.
void RemoveVectorVariables ()
 Remove all the vector variables.
virtual void ReplaceInvalidValuesOff ()
 When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported.
virtual void ReplaceInvalidValuesOn ()
 When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported.
void SetFunction (string function)
 Set/Get input string to evaluate.
virtual void SetReplaceInvalidValues (int _arg)
 When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported.
virtual void SetReplacementValue (double _arg)
 When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported.
void SetScalarVariableValue (string 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 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.
void SetVectorVariableValue (string 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 SetVectorVariableValue (string variableName, IntPtr values)
 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 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 SetVectorVariableValue (int i, IntPtr values)
 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.

Static Public Member Functions

static new vtkFunctionParser New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkFunctionParser SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkFunctionParser"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "17vtkFunctionParser"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkFunctionParser_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkFunctionParser_GetFunction_01 (HandleRef pThis)
static internal int vtkFunctionParser_GetNumberOfScalarVariables_02 (HandleRef pThis)
static internal int vtkFunctionParser_GetNumberOfVectorVariables_03 (HandleRef pThis)
static internal int vtkFunctionParser_GetReplaceInvalidValues_04 (HandleRef pThis)
static internal double vtkFunctionParser_GetReplacementValue_05 (HandleRef pThis)
static internal double vtkFunctionParser_GetScalarResult_06 (HandleRef pThis)
static internal IntPtr vtkFunctionParser_GetScalarVariableName_07 (HandleRef pThis, int i)
static internal double vtkFunctionParser_GetScalarVariableValue_08 (HandleRef pThis, string variableName)
static internal double vtkFunctionParser_GetScalarVariableValue_09 (HandleRef pThis, int i)
static internal IntPtr vtkFunctionParser_GetVectorResult_10 (HandleRef pThis)
static internal void vtkFunctionParser_GetVectorResult_11 (HandleRef pThis, IntPtr result)
static internal IntPtr vtkFunctionParser_GetVectorVariableName_12 (HandleRef pThis, int i)
static internal IntPtr vtkFunctionParser_GetVectorVariableValue_13 (HandleRef pThis, string variableName)
static internal void vtkFunctionParser_GetVectorVariableValue_14 (HandleRef pThis, string variableName, IntPtr value)
static internal IntPtr vtkFunctionParser_GetVectorVariableValue_15 (HandleRef pThis, int i)
static internal void vtkFunctionParser_GetVectorVariableValue_16 (HandleRef pThis, int i, IntPtr value)
static internal int vtkFunctionParser_IsA_17 (HandleRef pThis, string type)
static internal int vtkFunctionParser_IsScalarResult_18 (HandleRef pThis)
static internal int vtkFunctionParser_IsTypeOf_19 (string type)
static internal int vtkFunctionParser_IsVectorResult_20 (HandleRef pThis)
static internal IntPtr vtkFunctionParser_NewInstance_22 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkFunctionParser_RemoveAllVariables_23 (HandleRef pThis)
static internal void vtkFunctionParser_RemoveScalarVariables_24 (HandleRef pThis)
static internal void vtkFunctionParser_RemoveVectorVariables_25 (HandleRef pThis)
static internal void vtkFunctionParser_ReplaceInvalidValuesOff_26 (HandleRef pThis)
static internal void vtkFunctionParser_ReplaceInvalidValuesOn_27 (HandleRef pThis)
static internal IntPtr vtkFunctionParser_SafeDownCast_28 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkFunctionParser_SetFunction_29 (HandleRef pThis, string function)
static internal void vtkFunctionParser_SetReplaceInvalidValues_30 (HandleRef pThis, int _arg)
static internal void vtkFunctionParser_SetReplacementValue_31 (HandleRef pThis, double _arg)
static internal void vtkFunctionParser_SetScalarVariableValue_32 (HandleRef pThis, string variableName, double value)
static internal void vtkFunctionParser_SetScalarVariableValue_33 (HandleRef pThis, int i, double value)
static internal void vtkFunctionParser_SetVectorVariableValue_34 (HandleRef pThis, string variableName, double xValue, double yValue, double zValue)
static internal void vtkFunctionParser_SetVectorVariableValue_35 (HandleRef pThis, string variableName, IntPtr values)
static internal void vtkFunctionParser_SetVectorVariableValue_36 (HandleRef pThis, int i, double xValue, double yValue, double zValue)
static internal void vtkFunctionParser_SetVectorVariableValue_37 (HandleRef pThis, int i, IntPtr values)

Static Private Member Functions

static vtkFunctionParser ()
 Automatically generated type registration mechanics.

Detailed Description

vtkFunctionParser - Parse and evaluate a mathematical expression

Description 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.

You can use the "if" operator to create conditional expressions such as if ( test, trueresult, falseresult). These evaluate the boolean valued test expression and then evaluate either the trueresult or the falseresult expression to produce a final (scalar or vector valued) value. "test" may contain <,>,=,|,&, and () and all three subexpressions can evaluate arbitrary function operators (ln, cos, +, if, etc)

Thanks Juha Nieminen (juha.nieminen@gmail.com) for relicensing this branch of the function parser code that this class is based upon under the new BSD license so that it could be used in VTK. Note, the BSD license applies to this version of the function parser only (by permission of the author), and not the original library.

Thomas Dunne (thomas.dunne@iwr.uni-heidelberg.de) for adding code for two-parameter-parsing and a few functions (sign, min, max).

Sid Sydoriak (sxs@lanl.gov) for adding boolean operations and conditional expressions and for fixing a variety of bugs.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkFunctionParser.vtkFunctionParser ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

override void Kitware.VTK.vtkFunctionParser.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

virtual string Kitware.VTK.vtkFunctionParser.GetFunction ( ) [virtual]

Set/Get input string to evaluate.

Get the number of scalar variables.

Get the number of vector variables.

When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported.

When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported.

Get a scalar result from evaluating the input function.

Get the ith scalar variable name.

Get the value of a scalar variable.

Get the value of a scalar variable.

Get a vector result from evaluating the input function.

Get a vector result from evaluating the input function.

Get the ith vector variable name.

double [] Kitware.VTK.vtkFunctionParser.GetVectorVariableValue ( string  variableName)

Get the value of a vector variable.

void Kitware.VTK.vtkFunctionParser.GetVectorVariableValue ( string  variableName,
IntPtr  value 
)

Get the value of a vector variable.

Get the value of a vector variable.

void Kitware.VTK.vtkFunctionParser.GetVectorVariableValue ( int  i,
IntPtr  value 
)

Get the value of a vector variable.

override int Kitware.VTK.vtkFunctionParser.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

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

static new int Kitware.VTK.vtkFunctionParser.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Remove all the current variables.

Remove all the scalar variables.

Remove all the vector variables.

When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported.

When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

void Kitware.VTK.vtkFunctionParser.SetFunction ( string  function)

Set/Get input string to evaluate.

virtual void Kitware.VTK.vtkFunctionParser.SetReplaceInvalidValues ( int  _arg) [virtual]

When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported.

virtual void Kitware.VTK.vtkFunctionParser.SetReplacementValue ( double  _arg) [virtual]

When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. Otherwise an error will be reported.

void Kitware.VTK.vtkFunctionParser.SetScalarVariableValue ( string  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 Kitware.VTK.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.

void Kitware.VTK.vtkFunctionParser.SetVectorVariableValue ( string  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 Kitware.VTK.vtkFunctionParser.SetVectorVariableValue ( string  variableName,
IntPtr  values 
)

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 Kitware.VTK.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 Kitware.VTK.vtkFunctionParser.SetVectorVariableValue ( int  i,
IntPtr  values 
)

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.

static internal IntPtr Kitware.VTK.vtkFunctionParser.vtkFunctionParser_GetFunction_01 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkFunctionParser.vtkFunctionParser_GetNumberOfScalarVariables_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkFunctionParser.vtkFunctionParser_GetNumberOfVectorVariables_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkFunctionParser.vtkFunctionParser_GetReplaceInvalidValues_04 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkFunctionParser.vtkFunctionParser_GetReplacementValue_05 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkFunctionParser.vtkFunctionParser_GetScalarResult_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkFunctionParser.vtkFunctionParser_GetScalarVariableName_07 ( HandleRef  pThis,
int  i 
) [private]
static internal double Kitware.VTK.vtkFunctionParser.vtkFunctionParser_GetScalarVariableValue_08 ( HandleRef  pThis,
string  variableName 
) [private]
static internal double Kitware.VTK.vtkFunctionParser.vtkFunctionParser_GetScalarVariableValue_09 ( HandleRef  pThis,
int  i 
) [private]
static internal IntPtr Kitware.VTK.vtkFunctionParser.vtkFunctionParser_GetVectorResult_10 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkFunctionParser.vtkFunctionParser_GetVectorResult_11 ( HandleRef  pThis,
IntPtr  result 
) [private]
static internal IntPtr Kitware.VTK.vtkFunctionParser.vtkFunctionParser_GetVectorVariableName_12 ( HandleRef  pThis,
int  i 
) [private]
static internal IntPtr Kitware.VTK.vtkFunctionParser.vtkFunctionParser_GetVectorVariableValue_13 ( HandleRef  pThis,
string  variableName 
) [private]
static internal void Kitware.VTK.vtkFunctionParser.vtkFunctionParser_GetVectorVariableValue_14 ( HandleRef  pThis,
string  variableName,
IntPtr  value 
) [private]
static internal IntPtr Kitware.VTK.vtkFunctionParser.vtkFunctionParser_GetVectorVariableValue_15 ( HandleRef  pThis,
int  i 
) [private]
static internal void Kitware.VTK.vtkFunctionParser.vtkFunctionParser_GetVectorVariableValue_16 ( HandleRef  pThis,
int  i,
IntPtr  value 
) [private]
static internal int Kitware.VTK.vtkFunctionParser.vtkFunctionParser_IsA_17 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkFunctionParser.vtkFunctionParser_IsScalarResult_18 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkFunctionParser.vtkFunctionParser_IsTypeOf_19 ( string  type) [private]
static internal int Kitware.VTK.vtkFunctionParser.vtkFunctionParser_IsVectorResult_20 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkFunctionParser.vtkFunctionParser_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkFunctionParser.vtkFunctionParser_NewInstance_22 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkFunctionParser.vtkFunctionParser_RemoveAllVariables_23 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkFunctionParser.vtkFunctionParser_RemoveScalarVariables_24 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkFunctionParser.vtkFunctionParser_RemoveVectorVariables_25 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkFunctionParser.vtkFunctionParser_ReplaceInvalidValuesOff_26 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkFunctionParser.vtkFunctionParser_ReplaceInvalidValuesOn_27 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkFunctionParser.vtkFunctionParser_SafeDownCast_28 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkFunctionParser.vtkFunctionParser_SetFunction_29 ( HandleRef  pThis,
string  function 
) [private]
static internal void Kitware.VTK.vtkFunctionParser.vtkFunctionParser_SetReplaceInvalidValues_30 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkFunctionParser.vtkFunctionParser_SetReplacementValue_31 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkFunctionParser.vtkFunctionParser_SetScalarVariableValue_32 ( HandleRef  pThis,
string  variableName,
double  value 
) [private]
static internal void Kitware.VTK.vtkFunctionParser.vtkFunctionParser_SetScalarVariableValue_33 ( HandleRef  pThis,
int  i,
double  value 
) [private]
static internal void Kitware.VTK.vtkFunctionParser.vtkFunctionParser_SetVectorVariableValue_34 ( HandleRef  pThis,
string  variableName,
double  xValue,
double  yValue,
double  zValue 
) [private]
static internal void Kitware.VTK.vtkFunctionParser.vtkFunctionParser_SetVectorVariableValue_35 ( HandleRef  pThis,
string  variableName,
IntPtr  values 
) [private]
static internal void Kitware.VTK.vtkFunctionParser.vtkFunctionParser_SetVectorVariableValue_36 ( HandleRef  pThis,
int  i,
double  xValue,
double  yValue,
double  zValue 
) [private]
static internal void Kitware.VTK.vtkFunctionParser.vtkFunctionParser_SetVectorVariableValue_37 ( HandleRef  pThis,
int  i,
IntPtr  values 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkFunctionParser.MRClassNameKey = "17vtkFunctionParser" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

new const string Kitware.VTK.vtkFunctionParser.MRFullTypeName = "Kitware.VTK.vtkFunctionParser"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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