SAGA API v9.10
Loading...
Searching...
No Matches
parameters.h File Reference
#include "grids.h"
#include "table.h"
#include "shapes.h"
#include "tin.h"
#include "pointcloud.h"
#include "datetime.h"

Go to the source code of this file.

Classes

class  CSG_Parameter
class  CSG_Parameter_Node
class  CSG_Parameter_Bool
class  CSG_Parameter_Value
class  CSG_Parameter_Int
class  CSG_Parameter_Double
class  CSG_Parameter_Degree
class  CSG_Parameter_Date
class  CSG_Parameter_Range
class  CSG_Parameter_Choice
class  CSG_Parameter_Data_Type
class  CSG_Parameter_Choices
class  CSG_Parameter_String
class  CSG_Parameter_Text
class  CSG_Parameter_File_Name
class  CSG_Parameter_Font
class  CSG_Parameter_Color
class  CSG_Parameter_Colors
class  CSG_Parameter_Fixed_Table
class  CSG_Parameter_Grid_System
class  CSG_Parameter_Table_Field
class  CSG_Parameter_Table_Fields
class  CSG_Parameter_Data_Object
class  CSG_Parameter_Data_Object_Output
class  CSG_Parameter_Grid
class  CSG_Parameter_Grids
class  CSG_Parameter_Table
class  CSG_Parameter_Shapes
class  CSG_Parameter_TIN
class  CSG_Parameter_PointCloud
class  CSG_Parameter_List
class  CSG_Parameter_Grid_List
class  CSG_Parameter_Grids_List
class  CSG_Parameter_Table_List
class  CSG_Parameter_Shapes_List
class  CSG_Parameter_TIN_List
class  CSG_Parameter_PointCloud_List
class  CSG_Parameter_Parameters
class  CSG_Parameters_CRSPicker
class  CSG_Parameters_Grid_Target
class  CSG_Parameters

Macros

#define PARAMETER_INPUT   0x01
#define PARAMETER_OUTPUT   0x02
#define PARAMETER_OPTIONAL   0x04
#define PARAMETER_INFORMATION   0x08
#define PARAMETER_IGNORE_PROJECTION   0x10
#define PARAMETER_NOT_FOR_GUI   0x20
#define PARAMETER_NOT_FOR_CMD   0x40
#define PARAMETER_GUI_COLLAPSED   0x80
#define PARAMETER_INPUT_OPTIONAL   (PARAMETER_INPUT | PARAMETER_OPTIONAL)
#define PARAMETER_OUTPUT_OPTIONAL   (PARAMETER_OUTPUT | PARAMETER_OPTIONAL)
#define PARAMETER_DESCRIPTION_NAME   0x01
#define PARAMETER_DESCRIPTION_TYPE   0x02
#define PARAMETER_DESCRIPTION_OPTIONAL   0x04
#define PARAMETER_DESCRIPTION_PROPERTIES   0x08
#define PARAMETER_DESCRIPTION_TEXT   0x10
#define PARAMETER_DESCRIPTION_ALL   (PARAMETER_DESCRIPTION_NAME | PARAMETER_DESCRIPTION_TYPE | PARAMETER_DESCRIPTION_OPTIONAL | PARAMETER_DESCRIPTION_PROPERTIES | PARAMETER_DESCRIPTION_TEXT)
#define PARAMETER_CHECK_VALUES   0x01
#define PARAMETER_CHECK_ENABLE   0x02
#define PARAMETER_CHECK_ALL   (PARAMETER_CHECK_VALUES | PARAMETER_CHECK_ENABLE)
#define SG_PARAMETER_DATA_SET_FALSE   0
#define SG_PARAMETER_DATA_SET_TRUE   1
#define SG_PARAMETER_DATA_SET_CHANGED   2

Typedefs

typedef int(* TSG_PFNC_Parameter_Changed) (CSG_Parameter *pParameter, int Flags)

Enumerations

enum  TSG_Parameter_Type {
  PARAMETER_TYPE_Node = 0 , PARAMETER_TYPE_Bool , PARAMETER_TYPE_Int , PARAMETER_TYPE_Double ,
  PARAMETER_TYPE_Degree , PARAMETER_TYPE_Date , PARAMETER_TYPE_Range , PARAMETER_TYPE_Data_Type ,
  PARAMETER_TYPE_Choice , PARAMETER_TYPE_Choices , PARAMETER_TYPE_String , PARAMETER_TYPE_Text ,
  PARAMETER_TYPE_FilePath , PARAMETER_TYPE_Font , PARAMETER_TYPE_Color , PARAMETER_TYPE_Colors ,
  PARAMETER_TYPE_FixedTable , PARAMETER_TYPE_Grid_System , PARAMETER_TYPE_Table_Field , PARAMETER_TYPE_Table_Fields ,
  PARAMETER_TYPE_PointCloud , PARAMETER_TYPE_Grid , PARAMETER_TYPE_Grids , PARAMETER_TYPE_Table ,
  PARAMETER_TYPE_Shapes , PARAMETER_TYPE_TIN , PARAMETER_TYPE_Grid_List , PARAMETER_TYPE_Grids_List ,
  PARAMETER_TYPE_Table_List , PARAMETER_TYPE_Shapes_List , PARAMETER_TYPE_TIN_List , PARAMETER_TYPE_PointCloud_List ,
  PARAMETER_TYPE_DataObject_Output , PARAMETER_TYPE_Parameters , PARAMETER_TYPE_Undefined
}

Functions

SAGA_API_DLL_EXPORT CSG_String SG_Parameter_Type_Get_Name (TSG_Parameter_Type Type)
SAGA_API_DLL_EXPORT CSG_String SG_Parameter_Type_Get_Identifier (TSG_Parameter_Type Type)
SAGA_API_DLL_EXPORT TSG_Parameter_Type SG_Parameter_Type_Get_Type (const CSG_String &Identifier)

Detailed Description

The core classes defining the parameters for SAGA tool interfaces.

See also
CSG_Parameters
CSG_Parameter

Definition in file parameters.h.

Macro Definition Documentation

◆ PARAMETER_CHECK_ALL

#define PARAMETER_CHECK_ALL   (PARAMETER_CHECK_VALUES | PARAMETER_CHECK_ENABLE)

Definition at line 192 of file parameters.h.

◆ PARAMETER_CHECK_ENABLE

#define PARAMETER_CHECK_ENABLE   0x02

Definition at line 191 of file parameters.h.

Referenced by CSG_Tool::_On_Parameter_Changed().

◆ PARAMETER_CHECK_VALUES

#define PARAMETER_CHECK_VALUES   0x01

Definition at line 190 of file parameters.h.

Referenced by CSG_Tool::_On_Parameter_Changed().

◆ PARAMETER_DESCRIPTION_ALL

#define PARAMETER_DESCRIPTION_ALL   (PARAMETER_DESCRIPTION_NAME | PARAMETER_DESCRIPTION_TYPE | PARAMETER_DESCRIPTION_OPTIONAL | PARAMETER_DESCRIPTION_PROPERTIES | PARAMETER_DESCRIPTION_TEXT)

Definition at line 112 of file parameters.h.

◆ PARAMETER_DESCRIPTION_NAME

#define PARAMETER_DESCRIPTION_NAME   0x01

Definition at line 107 of file parameters.h.

Referenced by CSG_Parameter::Get_Description().

◆ PARAMETER_DESCRIPTION_OPTIONAL

#define PARAMETER_DESCRIPTION_OPTIONAL   0x04

Definition at line 109 of file parameters.h.

Referenced by CSG_Parameter::Get_Description().

◆ PARAMETER_DESCRIPTION_PROPERTIES

#define PARAMETER_DESCRIPTION_PROPERTIES   0x08

Definition at line 110 of file parameters.h.

Referenced by CSG_Parameter::Get_Description(), and CSG_Tool::Get_Summary().

◆ PARAMETER_DESCRIPTION_TEXT

#define PARAMETER_DESCRIPTION_TEXT   0x10

Definition at line 111 of file parameters.h.

Referenced by CSG_Parameter::Get_Description().

◆ PARAMETER_DESCRIPTION_TYPE

#define PARAMETER_DESCRIPTION_TYPE   0x02

Definition at line 108 of file parameters.h.

Referenced by CSG_Parameter::Get_Description(), and CSG_Tool::Get_Summary().

◆ PARAMETER_GUI_COLLAPSED

#define PARAMETER_GUI_COLLAPSED   0x80

Definition at line 101 of file parameters.h.

Referenced by CSG_Parameters::Add_Node(), CSG_Parameter::is_Collapsed(), and CSG_Parameter::Set_Collapsed().

◆ PARAMETER_IGNORE_PROJECTION

#define PARAMETER_IGNORE_PROJECTION   0x10

Definition at line 98 of file parameters.h.

Referenced by CSG_Parameter::ignore_Projection(), and CSG_Parameter::ignore_Projection().

◆ PARAMETER_INFORMATION

#define PARAMETER_INFORMATION   0x08

Definition at line 97 of file parameters.h.

Referenced by CSG_Parameters::Add_Node(), and CSG_Parameter::is_Information().

◆ PARAMETER_INPUT

#define PARAMETER_INPUT   0x01

Definition at line 94 of file parameters.h.

Referenced by CSG_Tool_Chain::Create(), and CSG_Parameter::is_Input().

◆ PARAMETER_INPUT_OPTIONAL

#define PARAMETER_INPUT_OPTIONAL   (PARAMETER_INPUT | PARAMETER_OPTIONAL)

Definition at line 103 of file parameters.h.

Referenced by CSG_Parameters::Add_Grid_or_Const(), CSG_Parameters_Grid_Target::Create(), and CSG_Tool_Chain::Create().

◆ PARAMETER_NOT_FOR_CMD

#define PARAMETER_NOT_FOR_CMD   0x40

Definition at line 100 of file parameters.h.

Referenced by CSG_Parameter::do_UseInCMD(), and CSG_Parameter::Set_UseInCMD().

◆ PARAMETER_NOT_FOR_GUI

#define PARAMETER_NOT_FOR_GUI   0x20

Definition at line 99 of file parameters.h.

Referenced by CSG_Parameter::do_UseInGUI(), and CSG_Parameter::Set_UseInGUI().

◆ PARAMETER_OPTIONAL

#define PARAMETER_OPTIONAL   0x04

Definition at line 96 of file parameters.h.

Referenced by CSG_Parameters::Add_Grid_List(), CSG_Parameters::Add_Grids_List(), CSG_Parameters::Add_Table_Field(), and CSG_Parameter::is_Optional().

◆ PARAMETER_OUTPUT

#define PARAMETER_OUTPUT   0x02

Definition at line 95 of file parameters.h.

Referenced by CSG_Parameters_Grid_Target::Add_Grid(), CSG_Parameters::Add_Grid_List(), CSG_Parameters_Grid_Target::Add_Grids(), CSG_Parameters::Add_Grids_List(), CSG_Tool_Chain::Create(), and CSG_Parameter::is_Output().

◆ PARAMETER_OUTPUT_OPTIONAL

#define PARAMETER_OUTPUT_OPTIONAL   (PARAMETER_OUTPUT | PARAMETER_OPTIONAL)

Definition at line 104 of file parameters.h.

Referenced by CSG_Parameters_Grid_Target::Add_Grid(), CSG_Parameters::Add_Grid_Output(), CSG_Parameters_Grid_Target::Add_Grids(), CSG_Parameters::Add_Grids_Output(), CSG_Parameters::Add_PointCloud_Output(), CSG_Parameters::Add_Shapes_Output(), CSG_Parameters::Add_Table_Output(), CSG_Parameters::Add_TIN_Output(), and CSG_Tool_Chain::Create().

◆ SG_PARAMETER_DATA_SET_CHANGED

#define SG_PARAMETER_DATA_SET_CHANGED   2

Definition at line 197 of file parameters.h.

Referenced by CSG_Parameter_Bool::_Set_Value(), CSG_Parameter_Choice::_Set_Value(), CSG_Parameter_Choice::_Set_Value(), CSG_Parameter_Choices::_Set_Value(), CSG_Parameter_Colors::_Set_Value(), CSG_Parameter_Colors::_Set_Value(), CSG_Parameter_Colors::_Set_Value(), CSG_Parameter_Data_Object::_Set_Value(), CSG_Parameter_Data_Object_Output::_Set_Value(), CSG_Parameter_Date::_Set_Value(), CSG_Parameter_Date::_Set_Value(), CSG_Parameter_Double::_Set_Value(), CSG_Parameter_Fixed_Table::_Set_Value(), CSG_Parameter_Font::_Set_Value(), CSG_Parameter_Font::_Set_Value(), CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Grid_System::_Set_Value(), CSG_Parameter_Int::_Set_Value(), CSG_Parameter_List::_Set_Value(), CSG_Parameter_PointCloud::_Set_Value(), CSG_Parameter_Range::_Set_Value(), CSG_Parameter_Shapes::_Set_Value(), CSG_Parameter_String::_Set_Value(), CSG_Parameter_Table::_Set_Value(), CSG_Parameter_Table_Field::_Set_Value(), CSG_Parameter_Table_Fields::_Set_Value(), CSG_Parameter_TIN::_Set_Value(), CSG_Parameter_Value::Set_Valid_Range(), CSG_Parameter::Set_Value(), CSG_Parameter::Set_Value(), CSG_Parameter::Set_Value(), CSG_Parameter::Set_Value(), and CSG_Parameter::Set_Value().

◆ SG_PARAMETER_DATA_SET_FALSE

#define SG_PARAMETER_DATA_SET_FALSE   0

Definition at line 195 of file parameters.h.

Referenced by CSG_Parameter::_Set_Value(), CSG_Parameter::_Set_Value(), CSG_Parameter::_Set_Value(), CSG_Parameter::_Set_Value(), CSG_Parameter::_Set_Value(), CSG_Parameter_Bool::_Set_Value(), CSG_Parameter_Choice::_Set_Value(), CSG_Parameter_Choice::_Set_Value(), CSG_Parameter_Choice::_Set_Value(), CSG_Parameter_Color::_Set_Value(), CSG_Parameter_Colors::_Set_Value(), CSG_Parameter_Colors::_Set_Value(), CSG_Parameter_Colors::_Set_Value(), CSG_Parameter_Date::_Set_Value(), CSG_Parameter_Double::_Set_Value(), CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Grid_System::_Set_Value(), CSG_Parameter_Int::_Set_Value(), CSG_Parameter_Range::_Set_Value(), CSG_Parameter_Shapes::_Set_Value(), CSG_Parameter_Value::Set_Valid_Range(), CSG_Parameter::Set_Value(), CSG_Parameter::Set_Value(), CSG_Parameter::Set_Value(), CSG_Parameter::Set_Value(), and CSG_Parameter::Set_Value().

◆ SG_PARAMETER_DATA_SET_TRUE

#define SG_PARAMETER_DATA_SET_TRUE   1

Definition at line 196 of file parameters.h.

Referenced by CSG_Parameter_Bool::_Set_Value(), CSG_Parameter_Choice::_Set_Value(), CSG_Parameter_Choice::_Set_Value(), CSG_Parameter_Data_Object::_Set_Value(), CSG_Parameter_Data_Object_Output::_Set_Value(), CSG_Parameter_Date::_Set_Value(), CSG_Parameter_Date::_Set_Value(), CSG_Parameter_Double::_Set_Value(), CSG_Parameter_Fixed_Table::_Set_Value(), CSG_Parameter_Font::_Set_Value(), CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Grid_System::_Set_Value(), CSG_Parameter_Int::_Set_Value(), CSG_Parameter_List::_Set_Value(), CSG_Parameter_PointCloud::_Set_Value(), CSG_Parameter_Shapes::_Set_Value(), CSG_Parameter_String::_Set_Value(), CSG_Parameter_Table::_Set_Value(), CSG_Parameter_Table_Field::_Set_Value(), and CSG_Parameter_TIN::_Set_Value().

Typedef Documentation

◆ TSG_PFNC_Parameter_Changed

typedef int(* TSG_PFNC_Parameter_Changed) (CSG_Parameter *pParameter, int Flags)

Definition at line 1697 of file parameters.h.

Enumeration Type Documentation

◆ TSG_Parameter_Type

enum TSG_Parameter_Type
Enumerator
PARAMETER_TYPE_Node 
PARAMETER_TYPE_Bool 
PARAMETER_TYPE_Int 
PARAMETER_TYPE_Double 
PARAMETER_TYPE_Degree 
PARAMETER_TYPE_Date 
PARAMETER_TYPE_Range 
PARAMETER_TYPE_Data_Type 
PARAMETER_TYPE_Choice 
PARAMETER_TYPE_Choices 
PARAMETER_TYPE_String 
PARAMETER_TYPE_Text 
PARAMETER_TYPE_FilePath 
PARAMETER_TYPE_Font 
PARAMETER_TYPE_Color 
PARAMETER_TYPE_Colors 
PARAMETER_TYPE_FixedTable 
PARAMETER_TYPE_Grid_System 
PARAMETER_TYPE_Table_Field 
PARAMETER_TYPE_Table_Fields 
PARAMETER_TYPE_PointCloud 
PARAMETER_TYPE_Grid 
PARAMETER_TYPE_Grids 
PARAMETER_TYPE_Table 
PARAMETER_TYPE_Shapes 
PARAMETER_TYPE_TIN 
PARAMETER_TYPE_Grid_List 
PARAMETER_TYPE_Grids_List 
PARAMETER_TYPE_Table_List 
PARAMETER_TYPE_Shapes_List 
PARAMETER_TYPE_TIN_List 
PARAMETER_TYPE_PointCloud_List 
PARAMETER_TYPE_DataObject_Output 
PARAMETER_TYPE_Parameters 
PARAMETER_TYPE_Undefined 

Definition at line 122 of file parameters.h.

Function Documentation

◆ SG_Parameter_Type_Get_Identifier()

SAGA_API_DLL_EXPORT CSG_String SG_Parameter_Type_Get_Identifier ( TSG_Parameter_Type Type)

Definition at line 114 of file parameter_data.cpp.

References PARAMETER_TYPE_Bool, PARAMETER_TYPE_Choice, PARAMETER_TYPE_Choices, PARAMETER_TYPE_Color, PARAMETER_TYPE_Colors, PARAMETER_TYPE_Data_Type, PARAMETER_TYPE_DataObject_Output, PARAMETER_TYPE_Date, PARAMETER_TYPE_Degree, PARAMETER_TYPE_Double, PARAMETER_TYPE_FilePath, PARAMETER_TYPE_FixedTable, PARAMETER_TYPE_Font, PARAMETER_TYPE_Grid, PARAMETER_TYPE_Grid_List, PARAMETER_TYPE_Grid_System, PARAMETER_TYPE_Grids, PARAMETER_TYPE_Grids_List, PARAMETER_TYPE_Int, PARAMETER_TYPE_Node, PARAMETER_TYPE_Parameters, PARAMETER_TYPE_PointCloud, PARAMETER_TYPE_PointCloud_List, PARAMETER_TYPE_Range, PARAMETER_TYPE_Shapes, PARAMETER_TYPE_Shapes_List, PARAMETER_TYPE_String, PARAMETER_TYPE_Table, PARAMETER_TYPE_Table_Field, PARAMETER_TYPE_Table_Fields, PARAMETER_TYPE_Table_List, PARAMETER_TYPE_Text, PARAMETER_TYPE_TIN, and PARAMETER_TYPE_TIN_List.

Referenced by CSG_Parameter::Get_Type_Identifier().

◆ SG_Parameter_Type_Get_Name()

SAGA_API_DLL_EXPORT CSG_String SG_Parameter_Type_Get_Name ( TSG_Parameter_Type Type)

Definition at line 64 of file parameter_data.cpp.

References _TL, PARAMETER_TYPE_Bool, PARAMETER_TYPE_Choice, PARAMETER_TYPE_Choices, PARAMETER_TYPE_Color, PARAMETER_TYPE_Colors, PARAMETER_TYPE_Data_Type, PARAMETER_TYPE_DataObject_Output, PARAMETER_TYPE_Date, PARAMETER_TYPE_Degree, PARAMETER_TYPE_Double, PARAMETER_TYPE_FilePath, PARAMETER_TYPE_FixedTable, PARAMETER_TYPE_Font, PARAMETER_TYPE_Grid, PARAMETER_TYPE_Grid_List, PARAMETER_TYPE_Grid_System, PARAMETER_TYPE_Grids, PARAMETER_TYPE_Grids_List, PARAMETER_TYPE_Int, PARAMETER_TYPE_Node, PARAMETER_TYPE_Parameters, PARAMETER_TYPE_PointCloud, PARAMETER_TYPE_PointCloud_List, PARAMETER_TYPE_Range, PARAMETER_TYPE_Shapes, PARAMETER_TYPE_Shapes_List, PARAMETER_TYPE_String, PARAMETER_TYPE_Table, PARAMETER_TYPE_Table_Field, PARAMETER_TYPE_Table_Fields, PARAMETER_TYPE_Table_List, PARAMETER_TYPE_Text, PARAMETER_TYPE_TIN, and PARAMETER_TYPE_TIN_List.

Referenced by CSG_Parameter::Get_Type_Name().

◆ SG_Parameter_Type_Get_Type()

SAGA_API_DLL_EXPORT TSG_Parameter_Type SG_Parameter_Type_Get_Type ( const CSG_String & Identifier)

Definition at line 164 of file parameter_data.cpp.

References CSG_String::Cmp(), PARAMETER_TYPE_Bool, PARAMETER_TYPE_Choice, PARAMETER_TYPE_Choices, PARAMETER_TYPE_Color, PARAMETER_TYPE_Colors, PARAMETER_TYPE_Data_Type, PARAMETER_TYPE_DataObject_Output, PARAMETER_TYPE_Date, PARAMETER_TYPE_Degree, PARAMETER_TYPE_Double, PARAMETER_TYPE_FilePath, PARAMETER_TYPE_FixedTable, PARAMETER_TYPE_Font, PARAMETER_TYPE_Grid, PARAMETER_TYPE_Grid_List, PARAMETER_TYPE_Grid_System, PARAMETER_TYPE_Grids, PARAMETER_TYPE_Grids_List, PARAMETER_TYPE_Int, PARAMETER_TYPE_Node, PARAMETER_TYPE_Parameters, PARAMETER_TYPE_PointCloud, PARAMETER_TYPE_PointCloud_List, PARAMETER_TYPE_Range, PARAMETER_TYPE_Shapes, PARAMETER_TYPE_Shapes_List, PARAMETER_TYPE_String, PARAMETER_TYPE_Table, PARAMETER_TYPE_Table_Field, PARAMETER_TYPE_Table_Fields, PARAMETER_TYPE_Table_List, PARAMETER_TYPE_Text, PARAMETER_TYPE_TIN, PARAMETER_TYPE_TIN_List, and PARAMETER_TYPE_Undefined.

Referenced by CSG_Tool_Chain::Create().