|
SAGA API
v9.6
|
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;
222 const SG_Char * Get_Name (
void)
const;
223 const SG_Char * Get_Description (
void)
const;
224 bool Set_Description (
const CSG_String &Description);
228 bool Set_Enabled (
bool bEnabled =
true);
229 bool is_Enabled (
bool bCheckEnv =
true)
const;
231 virtual bool is_Valid (
void)
const {
return(
true ); }
236 bool is_Option (
void)
const;
237 bool is_DataObject (
void)
const;
238 bool is_DataObject_List (
void)
const;
239 bool is_Parameters (
void)
const;
240 bool is_Serializable (
void)
const;
244 void Set_UseInGUI (
bool bDoUse =
false);
245 void Set_UseInCMD (
bool bDoUse =
false);
247 bool do_UseInGUI (
void)
const;
248 bool do_UseInCMD (
void)
const;
250 void ignore_Projection (
bool bIgnore);
256 CSG_Parameter *
Get_Child (
int iChild)
const {
return( iChild >= 0 && iChild < m_nChildren ? m_Children[iChild] : NULL ); }
257 bool Set_Children_Enabled (
bool bEnabled =
true);
260 virtual bool Set_Value (
int Value);
261 virtual bool Set_Value (
double Value);
262 virtual bool Set_Value (
const CSG_String &Value);
263 virtual bool Set_Value (
const char *Value);
264 virtual bool Set_Value (
const wchar_t *Value);
265 virtual bool Set_Value (
void *Value);
268 virtual bool Toggle_Value (
void);
270 bool Set_Default (
int Value);
271 bool Set_Default (
double Value);
274 virtual bool is_Default (
void)
const;
275 virtual bool Restore_Default (
void);
277 bool Check (
bool bSilent =
true);
281 bool asBool (
void)
const {
return( (
bool )!!_asInt () ); }
282 int asInt (
void)
const {
return( (
int )_asInt () ); }
283 long asColor (
void)
const {
return( (
long )_asInt () ); }
284 double asDouble (
void)
const {
return( (
double )_asDouble () ); }
286 void *
asPointer (
void)
const {
return( (
void *)_asPointer() ); }
289 const SG_Char * asFont (
void)
const;
334 virtual int _Set_Value (
int Value);
335 virtual int _Set_Value (
double Value);
336 virtual int _Set_Value (
const CSG_String &Value);
337 virtual int _Set_Value (
void *Value);
339 virtual void _Set_String (
void);
341 virtual int _asInt (
void)
const;
342 virtual double _asDouble (
void)
const;
343 virtual void * _asPointer (
void)
const;
344 virtual const SG_Char * _asString (
void)
const;
347 virtual bool _Serialize (
CSG_MetaData &MetaData,
bool bSave);
357 int m_Constraint, m_nChildren;
361 CSG_String m_Identifier, m_Name, m_Description, m_Default;
419 virtual int _asInt (
void)
const {
return( m_Value ); }
438 bool Set_Valid_Range (
double Minimum,
double Maximum);
440 void Set_Minimum (
double Minimum,
bool bOn =
true);
444 void Set_Maximum (
double Maximum,
bool bOn =
true);
492 virtual int _asInt (
void)
const {
return( m_Value ); }
493 virtual double _asDouble (
void)
const {
return( m_Value ); }
530 virtual int _asInt (
void)
const {
return( (
int)m_Value ); }
531 virtual double _asDouble (
void)
const {
return( m_Value ); }
594 virtual int _asInt (
void)
const;
616 bool Set_Range (
double Min,
double Max);
617 double Get_Range (
void)
const {
return( Get_Max() - Get_Min() ); }
619 bool Set_Min (
double Min);
620 double Get_Min (
void)
const;
623 bool Set_Max (
double Max);
624 double Get_Max (
void)
const;
669 bool Del_Items (
void);
672 bool Set_Items (
const SG_Char *String);
675 const SG_Char * Get_Item (
int Index)
const;
680 bool Get_Data (
int &Value)
const;
681 bool Get_Data (
double &Value)
const;
683 int Get_Count (
void)
const {
return( m_Items.Get_Count() ); }
701 virtual int _asInt (
void)
const {
return( m_Value ); }
702 virtual double _asDouble (
void)
const {
return( m_Value ); }
756 void Del_Items (
void);
766 int Get_Selection_Index (
int i)
const {
return( i >= 0 && i < Get_Selection_Count() ? m_Selection[i] : -1 ); }
768 bool is_Selected (
int Index);
769 bool Select (
int Index,
bool bSelect =
true);
770 bool Clr_Selection (
void);
807 void Set_Password (
bool bOn);
808 bool is_Password (
void)
const;
859 void Set_Filter (
const SG_Char *Filter);
860 const SG_Char * Get_Filter (
void)
const;
862 void Set_Flag_Save (
bool bFlag);
863 bool is_Save (
void)
const {
return( m_bSave ); }
865 void Set_Flag_Multiple (
bool bFlag);
868 void Set_Flag_Directory (
bool bFlag);
914 virtual int _asInt (
void)
const;
974 virtual int _asInt (
void)
const;
1062 bool Add_Default (
double Value,
double Minimum,
bool bMinimum,
double Maximum,
bool bMaximum);
1103 int Get_Index (
int i)
const {
return( i >= 0 && i < m_nFields ? m_Fields[i] : -1 ); }
1105 int operator [] (
int i)
const {
return( i >= 0 && i < m_nFields ? m_Fields[i] : -1 ); }
1120 virtual int _asInt (
void)
const;
1140 virtual bool is_Valid (
void)
const;
1209 bool Add_Default (
double Value,
double Minimum,
bool bMinimum,
double Maximum,
bool bMaximum);
1223 virtual int _asInt (
void)
const;
1368 virtual bool Del_Item (
CSG_Data_Object *pItem,
bool bUpdateData =
true);
1369 virtual bool Del_Item (
int Index ,
bool bUpdateData =
true);
1370 virtual bool Del_Items (
void);
1387 virtual int _asInt (
void)
const;
1418 virtual bool Del_Item (
int Index ,
bool bUpdateData =
true);
1612 bool Activate_GUI (
bool bReset =
false);
1613 bool Deactivate_GUI (
void);
1618 bool Get_CRS (
CSG_Projection &Projection,
bool bMessage =
false)
const;
1646 bool Add_Grids (
const CSG_String &ID,
const CSG_String &Name,
bool bOptional,
bool bZLevels =
false);
1653 bool Set_User_Defined (
CSG_Parameters *pParameters,
const TSG_Rect &Extent,
int Rows = 0,
int Rounding = 2);
1655 bool Set_User_Defined (
CSG_Parameters *pParameters,
double xMin,
double yMin,
double Size,
int nx,
int ny);
1658 bool Set_User_Defined_ZLevels (
CSG_Parameters *pParameters,
double zMin,
double zMax,
int nLevels,
int Rounding = 2);
1702 bool Create (
const SG_Char *Name,
const SG_Char *Description = NULL,
const SG_Char *Identifier = NULL,
bool bGrid_System =
false);
1705 bool Create (
void *pOwner,
const SG_Char *Name,
const SG_Char *Description = NULL,
const SG_Char *Identifier = NULL,
bool bGrid_System =
false);
1713 void Set_Tool (
class CSG_Tool *pTool);
1718 bool Push (
class CSG_Data_Manager *pManager = NULL,
bool bRestoreDefaults =
true);
1721 bool Use_Grid_System (
void);
1723 bool has_GUI (
void)
const;
1727 void Set_Identifier (
const CSG_String &Identifier);
1728 bool Cmp_Identifier (
const CSG_String &Identifier)
const;
1734 void Set_Description (
const CSG_String &Description);
1739 void Del_References (
void);
1742 void Set_Enabled (
bool bEnabled =
true);
1743 void Set_Enabled (
const CSG_String &Identifier,
bool bEnabled =
true);
1747 bool Set_Callback (
bool bActive =
true);
1753 CSG_Parameter * Get_Parameter (
int i ,
bool MsgOnError )
const;
1755 CSG_Parameter * Get_Parameter (
const char *ID,
bool MsgOnError =
false)
const;
1756 CSG_Parameter * Get_Parameter (
const wchar_t *ID,
bool MsgOnError =
false)
const;
1760 CSG_Parameter * operator() (
const char *ID)
const {
return( Get_Parameter(ID) ); }
1761 CSG_Parameter * operator() (
const wchar_t *ID)
const {
return( Get_Parameter(ID) ); }
1765 CSG_Parameter & operator[] (
const char *ID)
const {
return( *Get_Parameter(ID) ); }
1766 CSG_Parameter & operator[] (
const wchar_t *ID)
const {
return( *Get_Parameter(ID) ); }
1769 bool Del_Parameter (
int i);
1772 bool Del_Parameters (
void);
1789 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);
1809 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);
1841 bool Set_Parameter (
const wchar_t *ID,
CSG_Parameter *pValue);
1864 bool Restore_Defaults (
bool bClearData =
false);
1881 bool Serialize_Compatibility (
CSG_File &Stream);
1884 bool DataObjects_Check (
bool bSilent =
false);
1887 bool Get_String (
CSG_String &String,
bool bOptionsOnly);
1888 bool Msg_String (
bool bOptionsOnly);
1890 bool Set_History (
CSG_MetaData &History,
bool bOptions =
true,
bool bDataObjects =
true);
1897 bool Reset_Grid_System (
void);
1910 CSG_String m_Identifier, m_Name, m_Description;
1923 void _On_Construction (
void);
1925 bool _On_Parameter_Changed (
CSG_Parameter *pParameter,
int Flags);
1927 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);
1928 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);
1934 bool DataObjects_Create (
void);
1935 bool DataObjects_Synchronize (
void);
1936 bool DataObjects_Get_Projection (
CSG_Projection &Projection)
const;
1937 bool DataObjects_Set_Projection (
const CSG_Projection &Projection);
1945 {
return( Add_Node (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description) ); }
1947 {
return( Add_Value (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Type, Value, Minimum, bMinimum, Maximum, bMaximum) ); }
1949 {
return( Add_Info_Value (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Type, Value) ); }
1951 {
return( Add_Bool (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Value) ); }
1953 {
return( Add_Int (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Value, Minimum, bMinimum, Maximum, bMaximum) ); }
1955 {
return( Add_Double (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Value, Minimum, bMinimum, Maximum, bMaximum) ); }
1957 {
return( Add_Degree (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Value, Minimum, bMinimum, Maximum, bMaximum) ); }
1959 {
return( Add_Date (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Value) ); }
1961 {
return( Add_Color (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Value) ); }
1963 {
return( Add_Range (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Range_Min, Range_Max, Minimum, bMinimum, Maximum, bMaximum) ); }
1965 {
return( Add_Info_Range (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Range_Min, Range_Max) ); }
1967 {
return( Add_Choice (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Items, Default) ); }
1969 {
return( Add_String (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, String, bLongText, bPassword) ); }
1971 {
return( Add_Info_String (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, String, bLongText) ); }
1973 {
return( Add_FilePath (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Filter, Default, bSave, bDirectory, bMultiple) ); }
1975 {
return( Add_Font (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, pInit) ); }
1977 {
return( Add_Colors (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, pInit) ); }
1979 {
return( Add_FixedTable (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, pInit) ); }
1981 {
return( Add_Grid_System (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, pInit) ); }
1983 {
return(
Add_Grid (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Constraint, bSystem_Dependent, Preferred_Type) ); }
1985 {
return( Add_Grid_or_Const (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Value, Minimum, bMinimum, Maximum, bMaximum, bSystem_Dependent) ); }
1987 {
return( Add_Grid_Output (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description) ); }
1989 {
return( Add_Grid_List (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Constraint, bSystem_Dependent) ); }
1991 {
return( Add_Table_Field (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, bAllowNone) ); }
1993 {
return( Add_Table_Field_or_Const(pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Value, Minimum, bMinimum, Maximum, bMaximum) ); }
1995 {
return( Add_Table_Fields (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description) ); }
1999 {
return( Add_Table_Output (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description) ); }
2001 {
return( Add_Table_List (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Constraint) ); }
2005 {
return( Add_Shapes_Output (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description) ); }
2007 {
return( Add_Shapes_List (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Constraint, Shape_Type) ); }
2011 {
return( Add_TIN_Output (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description) ); }
2013 {
return( Add_TIN_List (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Constraint) ); }
2017 {
return( Add_PointCloud_Output (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description) ); }
2019 {
return( Add_PointCloud_List (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description, Constraint) ); }
2021 {
return( Add_Parameters (pParent ? pParent->
Get_Identifier() :
SG_T(
""), ID, Name, Description) ); }
2035 #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
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_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
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
CSG_Grid * Add_Grid(void)
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)
CSG_Grids * Add_Grids(void)
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)
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
CSG_Shapes * Add_Shapes(void)
@ 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)