SAGA API v9.10
Loading...
Searching...
No Matches
CSG_Formula Class Reference

#include <mat_tools.h>

Classes

struct  SSG_Function

Public Types

typedef struct CSG_Formula::SSG_Function TSG_Function

Public Member Functions

 CSG_Formula (void)
virtual ~CSG_Formula (void)
bool Destroy (void)
bool Get_Error (CSG_String &Message)
bool Add_Function (const char *Name, TSG_Formula_Function_1 Function, int nParameters, bool bVarying=false)
bool Set_Formula (const CSG_String &Formula)
CSG_String Get_Formula (void) const
void Set_Variable (char Variable, double Value)
double Get_Value (void) const
double Get_Value (double x) const
double Get_Value (const CSG_Vector &Values) const
double Get_Value (double *Values, int nValues) const
double Get_Value (const char *Arguments,...) const
const char * Get_Used_Variables (void)

Static Public Member Functions

static CSG_String Get_Help_Operators (bool bHTML=true, const CSG_String Additional[][2]=NULL)

Detailed Description

Definition at line 1880 of file mat_tools.h.

Member Typedef Documentation

◆ TSG_Function

Constructor & Destructor Documentation

◆ CSG_Formula()

CSG_Formula::CSG_Formula ( void )

Definition at line 246 of file mat_formula.cpp.

References gSG_Functions, MAX_CTABLE, and SG_Calloc().

◆ ~CSG_Formula()

CSG_Formula::~CSG_Formula ( void )
virtual

Definition at line 269 of file mat_formula.cpp.

References Destroy(), and SG_Free().

Member Function Documentation

◆ Add_Function()

bool CSG_Formula::Add_Function ( const char * Name,
TSG_Formula_Function_1 Function,
int nParameters,
bool bVarying = false )

◆ Destroy()

bool CSG_Formula::Destroy ( void )

Definition at line 277 of file mat_formula.cpp.

References SG_FREE_SAFE.

Referenced by Set_Formula(), and ~CSG_Formula().

◆ Get_Error()

bool CSG_Formula::Get_Error ( CSG_String & Message)

Definition at line 385 of file mat_formula.cpp.

References _TL, CSG_String::Format(), CSG_String::Left(), and CSG_String::Right().

◆ Get_Formula()

CSG_String CSG_Formula::Get_Formula ( void ) const
inline

Definition at line 1895 of file mat_tools.h.

◆ Get_Help_Operators()

CSG_String CSG_Formula::Get_Help_Operators ( bool bHTML = true,
const CSG_String Additional[][2] = NULL )
static

Definition at line 295 of file mat_formula.cpp.

References _TL, CSG_String::is_Empty(), and CSG_String::Replace().

◆ Get_Used_Variables()

const char * CSG_Formula::Get_Used_Variables ( void )

Definition at line 663 of file mat_formula.cpp.

References CSG_String::Append(), and CSG_String::Clear().

◆ Get_Value() [1/5]

double CSG_Formula::Get_Value ( const char * Arguments,
... ) const

Definition at line 502 of file mat_formula.cpp.

◆ Get_Value() [2/5]

double CSG_Formula::Get_Value ( const CSG_Vector & Values) const

Definition at line 483 of file mat_formula.cpp.

References CSG_Vector::Get_Data(), CSG_Vector::Get_N(), and Get_Value().

◆ Get_Value() [3/5]

double CSG_Formula::Get_Value ( double * Values,
int nValues ) const

Definition at line 489 of file mat_formula.cpp.

◆ Get_Value() [4/5]

double CSG_Formula::Get_Value ( double x) const

Definition at line 471 of file mat_formula.cpp.

◆ Get_Value() [5/5]

double CSG_Formula::Get_Value ( void ) const

Definition at line 465 of file mat_formula.cpp.

Referenced by Get_Value().

◆ Set_Formula()

bool CSG_Formula::Set_Formula ( const CSG_String & Formula)

Definition at line 439 of file mat_formula.cpp.

References Destroy(), and CSG_String::Length().

◆ Set_Variable()

void CSG_Formula::Set_Variable ( char Variable,
double Value )

Definition at line 433 of file mat_formula.cpp.


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