 |
SAGA API
v9.2
|
Go to the documentation of this file.
53 #ifndef HEADER_INCLUDED__SAGA_API__parameters_H
54 #define HEADER_INCLUDED__SAGA_API__parameters_H
94 #define PARAMETER_INPUT 0x01
95 #define PARAMETER_OUTPUT 0x02
96 #define PARAMETER_OPTIONAL 0x04
97 #define PARAMETER_INFORMATION 0x08
98 #define PARAMETER_IGNORE_PROJECTION 0x10
99 #define PARAMETER_NOT_FOR_GUI 0x20
100 #define PARAMETER_NOT_FOR_CMD 0x40
102 #define PARAMETER_INPUT_OPTIONAL (PARAMETER_INPUT | PARAMETER_OPTIONAL)
103 #define PARAMETER_OUTPUT_OPTIONAL (PARAMETER_OUTPUT | PARAMETER_OPTIONAL)
106 #define PARAMETER_DESCRIPTION_NAME 0x01
107 #define PARAMETER_DESCRIPTION_TYPE 0x02
108 #define PARAMETER_DESCRIPTION_OPTIONAL 0x04
109 #define PARAMETER_DESCRIPTION_PROPERTIES 0x08
110 #define PARAMETER_DESCRIPTION_TEXT 0x10
111 #define PARAMETER_DESCRIPTION_ALL (PARAMETER_DESCRIPTION_NAME | PARAMETER_DESCRIPTION_TYPE | PARAMETER_DESCRIPTION_OPTIONAL | PARAMETER_DESCRIPTION_PROPERTIES | PARAMETER_DESCRIPTION_TEXT)
189 #define PARAMETER_CHECK_VALUES 0x01
190 #define PARAMETER_CHECK_ENABLE 0x02
191 #define PARAMETER_CHECK_ALL (PARAMETER_CHECK_VALUES | PARAMETER_CHECK_ENABLE)
194 #define SG_PARAMETER_DATA_SET_FALSE 0
195 #define SG_PARAMETER_DATA_SET_TRUE 1
196 #define SG_PARAMETER_DATA_SET_CHANGED 2
218 const SG_Char * Get_Identifier (
void)
const;
219 bool Cmp_Identifier (
const CSG_String &Identifier)
const;
221 const SG_Char * Get_Name (
void)
const;
222 const SG_Char * Get_Description (
void)
const;
223 bool Set_Description (
const CSG_String &Description);
227 bool Set_Enabled (
bool bEnabled =
true);
228 bool is_Enabled (
bool bCheckEnv =
true)
const;
230 virtual bool is_Valid (
void)
const {
return(
true ); }
235 bool is_Option (
void)
const;
236 bool is_DataObject (
void)
const;
237 bool is_DataObject_List (
void)
const;
238 bool is_Parameters (
void)
const;
239 bool is_Serializable (
void)
const;
243 void Set_UseInGUI (
bool bDoUse =
false);
244 void Set_UseInCMD (
bool bDoUse =
false);
246 bool do_UseInGUI (
void)
const;
247 bool do_UseInCMD (
void)
const;
249 void ignore_Projection (
bool bIgnore);
255 CSG_Parameter *
Get_Child (
int iChild)
const {
return( iChild >= 0 && iChild < m_nChildren ? m_Children[iChild] : NULL ); }
256 bool Set_Children_Enabled (
bool bEnabled =
true);
259 virtual bool Set_Value (
int Value);
260 virtual bool Set_Value (
double Value);
261 virtual bool Set_Value (
const CSG_String &Value);
262 virtual bool Set_Value (
const char *Value);
263 virtual bool Set_Value (
const wchar_t *Value);
264 virtual bool Set_Value (
void *Value);
267 virtual bool Toggle_Value (
void);
269 bool Set_Default (
int Value);
270 bool Set_Default (
double Value);
273 virtual bool is_Default (
void)
const;
274 virtual bool Restore_Default (
void);
276 bool Check (
bool bSilent =
true);
280 bool asBool (
void)
const {
return( (
bool )!!_asInt () ); }
281 int asInt (
void)
const {
return( (
int )_asInt () ); }
282 long asColor (
void)
const {
return( (
long )_asInt () ); }
283 double asDouble (
void)
const {
return( (
double )_asDouble () ); }
285 void *
asPointer (
void)
const {
return( (
void *)_asPointer() ); }
288 const SG_Char * asFont (
void)
const;
333 virtual int _Set_Value (
int Value);
334 virtual int _Set_Value (
double Value);
335 virtual int _Set_Value (
const CSG_String &Value);
336 virtual int _Set_Value (
void *Value);
338 virtual void _Set_String (
void);
340 virtual int _asInt (
void)
const;
341 virtual double _asDouble (
void)
const;
342 virtual void * _asPointer (
void)
const;
343 virtual const SG_Char * _asString (
void)
const;
346 virtual bool _Serialize (
CSG_MetaData &MetaData,
bool bSave);
356 int m_Constraint, m_nChildren;
360 CSG_String m_Identifier, m_Name, m_Description, m_Default;
418 virtual int _asInt (
void)
const {
return( m_Value ); }
437 bool Set_Valid_Range (
double Minimum,
double Maximum);
439 void Set_Minimum (
double Minimum,
bool bOn =
true);
443 void Set_Maximum (
double Maximum,
bool bOn =
true);
491 virtual int _asInt (
void)
const {
return( m_Value ); }
492 virtual double _asDouble (
void)
const {
return( m_Value ); }
529 virtual int _asInt (
void)
const {
return( (
int)m_Value ); }
530 virtual double _asDouble (
void)
const {
return( m_Value ); }
593 virtual int _asInt (
void)
const;
615 bool Set_Range (
double Min,
double Max);
616 double Get_Range (
void)
const {
return( Get_Max() - Get_Min() ); }
618 bool Set_Min (
double Min);
619 double Get_Min (
void)
const;
622 bool Set_Max (
double Max);
623 double Get_Max (
void)
const;
668 bool Del_Items (
void);
671 bool Set_Items (
const SG_Char *String);
674 const SG_Char * Get_Item (
int Index)
const;
679 bool Get_Data (
int &Value)
const;
680 bool Get_Data (
double &Value)
const;
682 int Get_Count (
void)
const {
return( m_Items.Get_Count() ); }
700 virtual int _asInt (
void)
const {
return( m_Value ); }
701 virtual double _asDouble (
void)
const {
return( m_Value ); }
755 void Del_Items (
void);
765 int Get_Selection_Index (
int i)
const {
return( i >= 0 && i < Get_Selection_Count() ? m_Selection[i] : -1 ); }
767 bool is_Selected (
int Index);
768 bool Select (
int Index,
bool bSelect =
true);
769 bool Clr_Selection (
void);
806 void Set_Password (
bool bOn);
807 bool is_Password (
void)
const;
858 void Set_Filter (
const SG_Char *Filter);
859 const SG_Char * Get_Filter (
void)
const;
861 void Set_Flag_Save (
bool bFlag);
862 bool is_Save (
void)
const {
return( m_bSave ); }
864 void Set_Flag_Multiple (
bool bFlag);
867 void Set_Flag_Directory (
bool bFlag);
913 virtual int _asInt (
void)
const;
973 virtual int _asInt (
void)
const;
1059 bool Add_Default (
double Value,
double Minimum,
bool bMinimum,
double Maximum,
bool bMaximum);
1100 int Get_Index (
int i)
const {
return( i >= 0 && i < m_nFields ? m_Fields[i] : -1 ); }
1115 virtual int _asInt (
void)
const;
1135 virtual bool is_Valid (
void)
const;
1204 bool Add_Default (
double Value,
double Minimum,
bool bMinimum,
double Maximum,
bool bMaximum);
1218 virtual int _asInt (
void)
const;
1363 virtual bool Del_Item (
CSG_Data_Object *pItem,
bool bUpdateData =
true);
1364 virtual bool Del_Item (
int Index ,
bool bUpdateData =
true);
1365 virtual bool Del_Items (
void);
1380 virtual int _asInt (
void)
const;
1411 virtual bool Del_Item (
int Index ,
bool bUpdateData =
true);
1607 bool Add_Grids (
const CSG_String &ID,
const CSG_String &Name,
bool bOptional,
bool bZLevels =
false);
1614 bool Set_User_Defined (
CSG_Parameters *pParameters,
const TSG_Rect &Extent,
int Rows = 0,
int Rounding = 2);
1616 bool Set_User_Defined (
CSG_Parameters *pParameters,
double xMin,
double yMin,
double Size,
int nx,
int ny);
1619 bool Set_User_Defined_ZLevels (
CSG_Parameters *pParameters,
double zMin,
double zMax,
int nLevels,
int Rounding = 2);
1662 bool Create (
const SG_Char *Name,
const SG_Char *Description = NULL,
const SG_Char *Identifier = NULL,
bool bGrid_System =
false);
1665 bool Create (
void *pOwner,
const SG_Char *Name,
const SG_Char *Description = NULL,
const SG_Char *Identifier = NULL,
bool bGrid_System =
false);
1677 bool Use_Grid_System (
void);
1679 bool has_GUI (
void)
const;
1683 void Set_Identifier (
const CSG_String &Identifier);
1684 bool Cmp_Identifier (
const CSG_String &Identifier)
const;
1690 void Set_Description (
const CSG_String &Description);
1695 void Del_References (
void);
1698 void Set_Enabled (
bool bEnabled =
true);
1699 void Set_Enabled (
const CSG_String &Identifier,
bool bEnabled =
true);
1703 bool Set_Callback (
bool bActive =
true);
1713 CSG_Parameter * operator() (
const char *ID)
const {
return( Get_Parameter(ID) ); }
1714 CSG_Parameter * operator() (
const wchar_t *ID)
const {
return( Get_Parameter(ID) ); }
1718 CSG_Parameter & operator[] (
const char *ID)
const {
return( *Get_Parameter(ID) ); }
1719 CSG_Parameter & operator[] (
const wchar_t *ID)
const {
return( *Get_Parameter(ID) ); }
1722 bool Del_Parameter (
int i);
1725 bool Del_Parameters (
void);
1742 CSG_Parameter * Add_Range (
const CSG_String &ParentID,
const CSG_String &ID,
const CSG_String &Name,
const CSG_String &Description,
double Range_Min = 0.0,
double Range_Max = 0.0,
double Minimum = 0.0,
bool bMinimum =
false,
double Maximum = 0.0,
bool bMaximum =
false);
1761 CSG_Parameter * Add_Grid_or_Const (
const CSG_String &ParentID,
const CSG_String &ID,
const CSG_String &Name,
const CSG_String &Description,
double Value = 0.0,
double Minimum = 0.0,
bool bMinimum =
false,
double Maximum = 0.0,
bool bMaximum =
false,
bool bSystem_Dependent =
true);
1793 bool Set_Parameter (
const wchar_t *ID,
CSG_Parameter *pValue);
1816 bool Restore_Defaults (
bool bClearData =
false);
1833 bool Serialize_Compatibility (
CSG_File &Stream);
1836 bool DataObjects_Check (
bool bSilent =
false);
1839 bool Get_String (
CSG_String &String,
bool bOptionsOnly);
1840 bool Msg_String (
bool bOptionsOnly);
1842 bool Set_History (
CSG_MetaData &History,
bool bOptions =
true,
bool bDataObjects =
true);
1849 bool Reset_Grid_System (
void);
1862 CSG_String m_Identifier, m_Name, m_Description;
1873 void _On_Construction (
void);
1875 bool _On_Parameter_Changed (
CSG_Parameter *pParameter,
int Flags);
1877 CSG_Parameter * _Add_Value (
const CSG_String &ParentID,
const CSG_String &ID,
const CSG_String &Name,
const CSG_String &Description,
bool bInformation,
TSG_Parameter_Type Type,
double Value,
double Minimum,
bool bMinimum,
double Maximum,
bool bMaximum);
1878 CSG_Parameter * _Add_Range (
const CSG_String &ParentID,
const CSG_String &ID,
const CSG_String &Name,
const CSG_String &Description,
bool bInformation,
double Range_Min,
double Range_Max,
double Minimum,
bool bMinimum,
double Maximum,
bool bMaximum);
1884 bool DataObjects_Create (
void);
1885 bool DataObjects_Synchronize (
void);
1886 bool DataObjects_Get_Projection (
CSG_Projection &Projection)
const;
1887 bool DataObjects_Set_Projection (
const CSG_Projection &Projection);
1895 {
return( Add_Node (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description) ); }
1897 {
return( Add_Value (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Type, Value, Minimum, bMinimum, Maximum, bMaximum) ); }
1899 {
return( Add_Info_Value (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Type, Value) ); }
1901 {
return( Add_Bool (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Value) ); }
1903 {
return( Add_Int (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Value, Minimum, bMinimum, Maximum, bMaximum) ); }
1905 {
return( Add_Double (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Value, Minimum, bMinimum, Maximum, bMaximum) ); }
1907 {
return( Add_Degree (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Value, Minimum, bMinimum, Maximum, bMaximum) ); }
1909 {
return( Add_Date (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Value) ); }
1911 {
return( Add_Color (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Value) ); }
1913 {
return( Add_Range (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Range_Min, Range_Max, Minimum, bMinimum, Maximum, bMaximum) ); }
1915 {
return( Add_Info_Range (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Range_Min, Range_Max) ); }
1917 {
return( Add_Choice (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Items, Default) ); }
1919 {
return( Add_String (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, String, bLongText, bPassword) ); }
1921 {
return( Add_Info_String (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, String, bLongText) ); }
1923 {
return( Add_FilePath (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Filter, Default, bSave, bDirectory, bMultiple) ); }
1925 {
return( Add_Font (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, pInit) ); }
1927 {
return( Add_Colors (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, pInit) ); }
1929 {
return( Add_FixedTable (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, pInit) ); }
1931 {
return( Add_Grid_System (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, pInit) ); }
1933 {
return(
Add_Grid (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Constraint, bSystem_Dependent, Preferred_Type) ); }
1935 {
return( Add_Grid_or_Const (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Value, Minimum, bMinimum, Maximum, bMaximum, bSystem_Dependent) ); }
1937 {
return( Add_Grid_Output (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description) ); }
1939 {
return( Add_Grid_List (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Constraint, bSystem_Dependent) ); }
1941 {
return( Add_Table_Field (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, bAllowNone) ); }
1943 {
return( Add_Table_Field_or_Const(pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Value, Minimum, bMinimum, Maximum, bMaximum) ); }
1945 {
return( Add_Table_Fields (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description) ); }
1949 {
return( Add_Table_Output (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description) ); }
1951 {
return( Add_Table_List (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Constraint) ); }
1955 {
return( Add_Shapes_Output (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description) ); }
1957 {
return( Add_Shapes_List (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Constraint, Shape_Type) ); }
1961 {
return( Add_TIN_Output (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description) ); }
1963 {
return( Add_TIN_List (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Constraint) ); }
1967 {
return( Add_PointCloud_Output (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description) ); }
1969 {
return( Add_PointCloud_List (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Constraint) ); }
1971 {
return( Add_Parameters (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description) ); }
1985 #endif // #ifndef HEADER_INCLUDED__SAGA_API__parameters_H
class CSG_Parameter_Grids_List * asGridsList(void) const
virtual TSG_Parameter_Type Get_Type(void) const
virtual TSG_Parameter_Type Get_Type(void) const
TSG_Shape_Type Get_Shape_Type(void) const
const CSG_String & Get_Description(void) const
void * asPointer(void) const
int Get_Selection_Count(void) const
CSG_Parameter * Add_Degree(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, double Value=0.0, double Minimum=0.0, bool bMinimum=false, double Maximum=0.0, bool bMaximum=false)
CSG_Parameter * Get_Parameter(int i) const
@ PARAMETER_TYPE_FilePath
CSG_Grid_System * Get_Grid_System(void) const
CSG_Parameter * Add_Shapes_Output(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
CSG_Parameter * Add_FixedTable(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, CSG_Table *pInit=NULL)
class CSG_Parameter_Shapes_List * asShapesList(void) const
CSG_Parameter * Add_Table(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
virtual bool Add_Item(CSG_Data_Object *pItem)
virtual bool _Assign(CSG_Parameter *pSource)
@ PARAMETER_TYPE_Table_Fields
virtual int _Set_Value(void *Value)
virtual void _Set_String(void)
TSG_Data_Object_Type m_Type
virtual int _asInt(void) const
virtual TSG_Parameter_Type Get_Type(void) const
const SG_Char * Get_Identifier(void) const
virtual int _Set_Value(int Value)
CSG_Parameter * Add_PointCloud(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
class CSG_Data_Manager * Get_Manager(void) const
const SG_Char * asString(void) const
#define PARAMETER_OPTIONAL
CSG_Parameter * Get_Grid_System_Parameter(void) const
void * Get_Owner(void) const
int Get_Index(int i) const
int Get_Grid_Count(void) const
double Get_Maximum(void) const
virtual bool is_Valid(void) const
bool has_Minimum(void) const
@ PARAMETER_TYPE_Grids_List
class CSG_Parameter_TIN_List * asTINList(void) const
virtual bool _Assign(CSG_Parameter *pSource)
CSG_Parameter * Add_TIN_List(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
class CSG_Parameter_Date * asDate(void) const
CSG_Data_Object * Get_Item(int Index) const
CSG_PointCloud * Get_PointCloud(int Index) const
virtual TSG_Parameter_Type Get_Type(void) const
friend class CSG_Parameter
CSG_PointCloud * Add_PointCloud(void)
CSG_Parameter * Add_Grid_Output(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
CSG_Parameter_Double * m_pMin
bool is_Input(void) const
virtual int _asInt(void) const
virtual bool _Assign(CSG_Parameter *pSource)
bool is_Managed(void) const
CSG_Parameter * Add_Info_Range(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, double Range_Min=0.0, double Range_Max=0.0)
CSG_Parameter * Add_Color(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Value=0)
SAGA_API_DLL_EXPORT CSG_String SG_Parameter_Type_Get_Name(TSG_Parameter_Type Type)
CSG_Data_Object * m_pDataObject
int Get_Item_Count(void) const
CSG_Parameter * Add_Shapes(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint, TSG_Shape_Type Shape_Type=SHAPE_TYPE_Undefined)
virtual void _Set_String(void)
@ PARAMETER_TYPE_FixedTable
CSG_Shapes * Add_Shapes(TSG_Shape_Type Type=SHAPE_TYPE_Undefined)
virtual TSG_Parameter_Type Get_Type(void) const
CSG_Parameter * Add_Shapes_List(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint, TSG_Shape_Type Shape_Type=SHAPE_TYPE_Undefined)
CSG_Parameter * Add_PointCloud_Output(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
TSG_Data_Type Get_Preferred_Type(void) const
virtual TSG_Parameter_Type Get_Type(void) const
virtual double _asDouble(void) const
bool Assign(CSG_Parameter *pSource)
SAGA_API_DLL_EXPORT CSG_String SG_Parameter_Type_Get_Identifier(TSG_Parameter_Type Type)
virtual TSG_Parameter_Type Get_Type(void) const
bool is_Directory(void) const
CSG_Parameter * Add_Choice(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, const CSG_String &Items, int Default=0)
virtual bool _Assign(CSG_Parameter *pSource)
@ PARAMETER_TYPE_PointCloud
virtual bool _Assign(CSG_Parameter *pSource)
CSG_Parameter * Add_Int(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Value=0, int Minimum=0, bool bMinimum=false, int Maximum=0, bool bMaximum=false)
virtual double _asDouble(void) const
class CSG_Parameter_Value * asValue(void) const
TSG_Data_Object_Type Get_DataObject_Type(void) const
SAGA_API_DLL_EXPORT TSG_Parameter_Type SG_Parameter_Type_Get_Type(const CSG_String &Identifier)
virtual TSG_Parameter_Type Get_Type(void) const
virtual int _Set_Value(int Value)
CSG_Parameter * Add_Node(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
bool is_Multiple(void) const
CSG_TIN * asTIN(int Index) const
CSG_Array_Pointer m_Grids
@ PARAMETER_TYPE_Shapes_List
class CSG_Parameter_Grid_List * asGridList(void) const
CSG_Parameters * m_pRange
virtual TSG_Parameter_Type Get_Type(void) const =0
CSG_Parameter * Add_Colors(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, CSG_Colors *pInit=NULL)
bool Serialize(CSG_MetaData &MetaData, bool bSave)
CSG_Table * Get_Table(int Index) const
CSG_Grid * Get_Grid(int Index) const
bool ignore_Projection(void) const
@ PARAMETER_TYPE_Data_Type
CSG_Parameter * Add_String(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, const CSG_String &String, bool bLongText=false, bool bPassword=false)
virtual bool Del_Items(void)
CSG_Parameter * Add_Parameters(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
virtual bool _Serialize(CSG_MetaData &Entry, bool bSave)
virtual TSG_Parameter_Type Get_Type(void) const
const CSG_String & Get_Item_Data(int i) const
CSG_Data_Collection * asTIN(void) const
CSG_Parameter * Add_Info_Value(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, TSG_Parameter_Type Type, double Value=0.0)
@ PARAMETER_TYPE_Undefined
virtual int _asInt(void) const
CSG_Grid * Add_Grid(const CSG_Grid_System &System, TSG_Data_Type Type=SG_DATATYPE_Undefined)
const CSG_String & Get_Selection_Data(int i) const
virtual bool Update_Data(void)
int Get_Count(void) const
@ PARAMETER_TYPE_Table_Field
virtual TSG_Parameter_Type Get_Type(void) const
const CSG_DateTime & Get_Date(void) const
CSG_Parameter * Add_Table_List(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
virtual bool Del_Item(CSG_Data_Object *pItem, bool bUpdateData=true)
virtual bool _Serialize(CSG_MetaData &MetaData, bool bSave)
CSG_Parameter * Add_Table_Field_or_Const(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, double Value=0.0, double Minimum=0.0, bool bMinimum=false, double Maximum=0.0, bool bMaximum=false)
class CSG_Tool * Get_Tool(void) const
double Get_Range(void) const
CSG_Parameter * Add_Table_Output(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
int Get_Count(void) const
class CSG_Parameter_Data_Type * asDataType(void) const
virtual void * _asPointer(void) const
CSG_Parameter * Get_Child(int iChild) const
virtual bool _Assign(CSG_Parameter *pSource)
#define PARAMETER_CHECK_ALL
CSG_Parameter * Add_TIN(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
bool Serialize(CSG_MetaData &Data) const
virtual TSG_Parameter_Type Get_Type(void) const
virtual double _asDouble(void) const
CSG_Parameter * Add_Grid_List(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint, bool bSystem_Dependent=true)
class CSG_Parameter_PointCloud_List * asPointCloudList(void) const
CSG_Parameter * Add_FilePath(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, const SG_Char *Filter=NULL, const SG_Char *Default=NULL, bool bSave=false, bool bDirectory=false, bool bMultiple=false)
CSG_Table * Add_Table(void)
#define PARAMETER_IGNORE_PROJECTION
virtual double _asDouble(void) const
CSG_Parameter * Add_Double(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, double Value=0.0, double Minimum=0.0, bool bMinimum=false, double Maximum=0.0, bool bMaximum=false)
CSG_Grids * Add_Grids(const CSG_String &File)
virtual TSG_Parameter_Type Get_Type(void) const
CSG_Parameter * Add_PointCloud_List(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
virtual TSG_Parameter_Type Get_Type(void) const
virtual bool Toggle_Value(void)
const CSG_Strings & Get_References(void) const
#define SAGA_API_DLL_EXPORT
virtual TSG_Parameter_Type Get_Type(void) const
@ PARAMETER_TYPE_Grid_List
virtual void _Set_String(void)
CSG_Parameter * Add_TIN_Output(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
virtual int _asInt(void) const
CSG_Parameter * Add_Date(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, double Value=0.0)
bool is_Optional(void) const
virtual TSG_Parameter_Type Get_Type(void) const
TSG_Shape_Type Get_Shape_Type(void) const
class CSG_Parameter_File_Name * asFilePath(void) const
CSG_Shapes * Get_Shapes(int Index) const
bool is_Output(void) const
CSG_Parameter * Add_Table_Fields(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
CSG_Parameter * Add_Bool(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, bool Value=false)
int Get_Item_Count(void) const
virtual TSG_Parameter_Type Get_Type(void) const
const CSG_String & Get_Identifier(void) const
virtual TSG_Parameter_Type Get_Type(void) const
bool has_Maximum(void) const
CSG_Parameter * Add_Grid_or_Const(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, double Value=0.0, double Minimum=0.0, bool bMinimum=false, double Maximum=0.0, bool bMaximum=false, bool bSystem_Dependent=true)
int Get_Children_Count(void) const
virtual TSG_Parameter_Type Get_Type(void) const
virtual int _Set_Value(int Value)
virtual bool _Serialize(CSG_MetaData &Entry, bool bSave)
CSG_Parameter * Add_Value(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, TSG_Parameter_Type Type, double Value=0.0, double Minimum=0.0, bool bMinimum=false, double Maximum=0.0, bool bMaximum=false)
virtual TSG_Parameter_Type Get_Type(void) const
class CSG_Parameter_Table_Fields * asTableFields(void) const
CSG_Parameters * m_pParameters
class CSG_Parameter_Choice * asChoice(void) const
#define PARAMETER_INFORMATION
virtual bool _Assign(CSG_Parameter *pSource)
bool Serialize(CSG_MetaData &Data, bool bSave)
virtual TSG_Parameter_Type Get_Type(void) const
virtual TSG_Parameter_Type Get_Type(void) const
int Get_Count(void) const
virtual TSG_Parameter_Type Get_Type(void) const
CSG_Array_Int m_Selection
double asDouble(void) const
virtual TSG_Parameter_Type Get_Type(void) const
@ PARAMETER_TYPE_Grid_System
virtual TSG_Parameter_Type Get_Type(void) const
virtual TSG_Parameter_Type Get_Type(void) const
const CSG_String & Get_Selection(int i) const
@ PARAMETER_TYPE_PointCloud_List
virtual TSG_Parameter_Type Get_Type(void) const
virtual TSG_Parameter_Type Get_Type(void) const
@ PARAMETER_TYPE_Table_List
double Get_Minimum(void) const
class CSG_Parameter_Range * asRange(void) const
int Get_Selection_Index(int i) const
virtual TSG_Parameter_Type Get_Type(void) const
virtual TSG_Parameter_Type Get_Type(void) const
class CSG_Parameter_Table_List * asTableList(void) const
int(* TSG_PFNC_Parameter_Changed)(CSG_Parameter *pParameter, int Flags)
CSG_Parameter * Add_Font(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, const SG_Char *pInit=NULL)
@ PARAMETER_TYPE_DataObject_Output
virtual TSG_Parameter_Type Get_Type(void) const
const CSG_String & Get_Item(int i) const
const CSG_String & Get_Name(void) const
CSG_Parameter_Double * Get_Min_Parameter(void) const
CSG_Parameter * Add_Grid_System(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, CSG_Grid_System *pInit=NULL)
virtual int _asInt(void) const
bool Serialize(const CSG_String &File, bool bSave)
virtual TSG_Parameter_Type Get_Type(void) const
virtual TSG_Parameter_Type Get_Type(void) const
CSG_Parameter * Add_Range(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, double Range_Min=0.0, double Range_Max=0.0, double Minimum=0.0, bool bMinimum=false, double Maximum=0.0, bool bMaximum=false)
bool Serialize(const CSG_String &File) const
virtual bool is_Default(void) const
CSG_Parameter_Double * Get_Max_Parameter(void) const
virtual TSG_Parameter_Type Get_Type(void) const
CSG_Grids * Get_Grids(int Index) const
virtual TSG_Parameter_Type Get_Type(void) const
@ PARAMETER_TYPE_TIN_List
@ PARAMETER_TYPE_Parameters
class CSG_Parameter_List * asList(void) const
CSG_Parameter * Add_Info_String(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, const CSG_String &String, bool bLongText=false)
virtual bool Restore_Default(void)
class CSG_Parameter_Choices * asChoices(void) const
bool is_Information(void) const
CSG_Parameter * Add_Grid(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint, bool bSystem_Dependent=true, TSG_Data_Type Preferred_Type=SG_DATATYPE_Undefined)
CSG_Parameter * Add_Table_Field(CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, bool bAllowNone=false)