SAGA API  v9.2
CSG_Parameters Class Reference

#include <parameters.h>

Public Member Functions

 CSG_Parameters (void)
 
virtual ~CSG_Parameters (void)
 
 CSG_Parameters (const CSG_Parameters &Parameters)
 
bool Create (const CSG_Parameters &Parameters)
 
 CSG_Parameters (const SG_Char *Name, const SG_Char *Description=NULL, const SG_Char *Identifier=NULL, bool bGrid_System=false)
 
bool Create (const SG_Char *Name, const SG_Char *Description=NULL, const SG_Char *Identifier=NULL, bool bGrid_System=false)
 
 CSG_Parameters (void *pOwner, const SG_Char *Name, const SG_Char *Description=NULL, const SG_Char *Identifier=NULL, bool bGrid_System=false)
 
bool Create (void *pOwner, const SG_Char *Name, const SG_Char *Description=NULL, const SG_Char *Identifier=NULL, bool bGrid_System=false)
 
void Destroy (void)
 
void * Get_Owner (void) const
 
class CSG_ToolGet_Tool (void) const
 
class CSG_Data_ManagerGet_Manager (void) const
 
void Set_Manager (class CSG_Data_Manager *pManager)
 
bool Use_Grid_System (void)
 
bool has_GUI (void) const
 
int Get_Count (void) const
 
void Set_Identifier (const CSG_String &Identifier)
 
bool Cmp_Identifier (const CSG_String &Identifier) const
 
const CSG_StringGet_Identifier (void) const
 
void Set_Name (const CSG_String &Name)
 
const CSG_StringGet_Name (void) const
 
void Set_Description (const CSG_String &Description)
 
const CSG_StringGet_Description (void) const
 
void Add_Reference (const CSG_String &Authors, const CSG_String &Year, const CSG_String &Title, const CSG_String &Where, const SG_Char *Link=NULL, const SG_Char *Link_Text=NULL)
 
void Add_Reference (const CSG_String &Link, const SG_Char *Link_Text=NULL)
 
void Del_References (void)
 
const CSG_StringsGet_References (void) const
 
void Set_Enabled (bool bEnabled=true)
 
void Set_Enabled (const CSG_String &Identifier, bool bEnabled=true)
 
TSG_PFNC_Parameter_Changed Set_Callback_On_Parameter_Changed (TSG_PFNC_Parameter_Changed pCallback)
 
bool Set_Callback (bool bActive=true)
 
CSG_Parametersoperator= (const CSG_Parameters &Parameters)
 
CSG_ParameterGet_Parameter (int i) const
 
CSG_ParameterGet_Parameter (const CSG_String &ID) const
 
CSG_Parameteroperator() (int i) const
 
CSG_Parameteroperator() (const CSG_String &ID) const
 
CSG_Parameteroperator() (const char *ID) const
 
CSG_Parameteroperator() (const wchar_t *ID) const
 
CSG_Parameteroperator[] (int i) const
 
CSG_Parameteroperator[] (const CSG_String &ID) const
 
CSG_Parameteroperator[] (const char *ID) const
 
CSG_Parameteroperator[] (const wchar_t *ID) const
 
bool Del_Parameter (int i)
 
bool Del_Parameter (const CSG_String &ID)
 
bool Del_Parameters (void)
 
CSG_ParameterAdd_Parameter (CSG_Parameter *pParameter)
 
CSG_ParameterAdd_Node (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
 
CSG_ParameterAdd_Value (const CSG_String &ParentID, 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)
 
CSG_ParameterAdd_Info_Value (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, TSG_Parameter_Type Type, double Value=0.0)
 
CSG_ParameterAdd_Bool (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, bool Value=false)
 
CSG_ParameterAdd_Int (const CSG_String &ParentID, 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)
 
CSG_ParameterAdd_Double (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)
 
CSG_ParameterAdd_Degree (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)
 
CSG_ParameterAdd_Date (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, double Value=0.0)
 
CSG_ParameterAdd_Color (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Value=0)
 
CSG_ParameterAdd_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)
 
CSG_ParameterAdd_Info_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)
 
CSG_ParameterAdd_Data_Type (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Data_Types, TSG_Data_Type Default=SG_DATATYPE_Undefined, const CSG_String &User="")
 
CSG_ParameterAdd_Choice (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, const CSG_String &Items, int Default=0)
 
CSG_ParameterAdd_Choices (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, const CSG_String &Items)
 
CSG_ParameterAdd_String (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, const CSG_String &String, bool bLongText=false, bool bPassword=false)
 
CSG_ParameterAdd_Info_String (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, const CSG_String &String, bool bLongText=false)
 
CSG_ParameterAdd_FilePath (const CSG_String &ParentID, 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_ParameterAdd_Font (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, const SG_Char *pInit=NULL)
 
CSG_ParameterAdd_Colors (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, CSG_Colors *pInit=NULL)
 
CSG_ParameterAdd_FixedTable (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, CSG_Table *pInit=NULL)
 
CSG_ParameterAdd_Grid_System (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, CSG_Grid_System *pInit=NULL)
 
CSG_ParameterAdd_Grid (const CSG_String &ParentID, 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_ParameterAdd_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)
 
CSG_ParameterAdd_Grid_Output (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
 
CSG_ParameterAdd_Grid_List (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint, bool bSystem_Dependent=true)
 
CSG_ParameterAdd_Grids (const CSG_String &ParentID, 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_ParameterAdd_Grids_Output (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
 
CSG_ParameterAdd_Grids_List (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint, bool bSystem_Dependent=true)
 
CSG_ParameterAdd_Table_Field (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, bool bAllowNone=false)
 
CSG_ParameterAdd_Table_Field_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)
 
CSG_ParameterAdd_Table_Fields (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
 
CSG_ParameterAdd_Table (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
 
CSG_ParameterAdd_Table_Output (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
 
CSG_ParameterAdd_Table_List (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
 
CSG_ParameterAdd_Shapes (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint, TSG_Shape_Type Shape_Type=SHAPE_TYPE_Undefined)
 
CSG_ParameterAdd_Shapes_Output (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
 
CSG_ParameterAdd_Shapes_List (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint, TSG_Shape_Type=SHAPE_TYPE_Undefined)
 
CSG_ParameterAdd_TIN (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
 
CSG_ParameterAdd_TIN_Output (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
 
CSG_ParameterAdd_TIN_List (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
 
CSG_ParameterAdd_PointCloud (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
 
CSG_ParameterAdd_PointCloud_Output (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
 
CSG_ParameterAdd_PointCloud_List (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
 
CSG_ParameterAdd_Parameters (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
 
bool Set_Parameter (const CSG_String &ID, CSG_Parameter *pValue)
 
bool Set_Parameter (const char *ID, CSG_Parameter *pValue)
 
bool Set_Parameter (const wchar_t *ID, CSG_Parameter *pValue)
 
bool Set_Parameter (const CSG_String &ID, void *Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const char *ID, void *Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const wchar_t *ID, void *Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const CSG_String &ID, CSG_Data_Object *Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const char *ID, CSG_Data_Object *Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const wchar_t *ID, CSG_Data_Object *Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const CSG_String &ID, int Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const char *ID, int Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const wchar_t *ID, int Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const CSG_String &ID, double Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const char *ID, double Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const wchar_t *ID, double Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const CSG_String &ID, const CSG_String &Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const char *ID, const CSG_String &Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const wchar_t *ID, const CSG_String &Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const CSG_String &ID, const char *Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const char *ID, const char *Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const wchar_t *ID, const char *Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const CSG_String &ID, const wchar_t *Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const char *ID, const wchar_t *Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Set_Parameter (const wchar_t *ID, const wchar_t *Value, int Type=PARAMETER_TYPE_Undefined)
 
bool Restore_Defaults (bool bClearData=false)
 
bool Assign (CSG_Parameters *pSource)
 
bool Assign_Values (CSG_Parameters *pSource)
 
bool Assign_Parameters (CSG_Parameters *pSource)
 
bool Load (const CSG_MetaData &Data)
 
bool Save (CSG_MetaData &Data) const
 
bool Load (const CSG_String &File)
 
bool Save (const CSG_String &File) const
 
bool Serialize (CSG_MetaData &Data, bool bSave)
 
bool Serialize (CSG_MetaData &Data) const
 
bool Serialize (const CSG_String &File, bool bSave)
 
bool Serialize (const CSG_String &File) const
 
bool Serialize_Compatibility (CSG_File &Stream)
 
bool DataObjects_Check (bool bSilent=false)
 
bool Get_String (CSG_String &String, bool bOptionsOnly)
 
bool Msg_String (bool bOptionsOnly)
 
bool Set_History (CSG_MetaData &History, bool bOptions=true, bool bDataObjects=true)
 
bool is_Managed (void) const
 
CSG_ParameterGet_Grid_System_Parameter (void) const
 
CSG_Grid_SystemGet_Grid_System (void) const
 
bool Set_Grid_System (const CSG_Grid_System &System)
 
bool Reset_Grid_System (void)
 
CSG_ParameterAdd_Node (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
 
CSG_ParameterAdd_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)
 
CSG_ParameterAdd_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)
 
CSG_ParameterAdd_Bool (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, bool Value=false)
 
CSG_ParameterAdd_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)
 
CSG_ParameterAdd_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_ParameterAdd_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_ParameterAdd_Date (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, double Value=0.0)
 
CSG_ParameterAdd_Color (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Value=0)
 
CSG_ParameterAdd_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)
 
CSG_ParameterAdd_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_ParameterAdd_Choice (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, const CSG_String &Items, int Default=0)
 
CSG_ParameterAdd_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)
 
CSG_ParameterAdd_Info_String (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, const CSG_String &String, bool bLongText=false)
 
CSG_ParameterAdd_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_ParameterAdd_Font (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, const SG_Char *pInit=NULL)
 
CSG_ParameterAdd_Colors (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, CSG_Colors *pInit=NULL)
 
CSG_ParameterAdd_FixedTable (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, CSG_Table *pInit=NULL)
 
CSG_ParameterAdd_Grid_System (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, CSG_Grid_System *pInit=NULL)
 
CSG_ParameterAdd_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_ParameterAdd_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)
 
CSG_ParameterAdd_Grid_Output (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
 
CSG_ParameterAdd_Grid_List (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint, bool bSystem_Dependent=true)
 
CSG_ParameterAdd_Table_Field (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, bool bAllowNone=false)
 
CSG_ParameterAdd_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)
 
CSG_ParameterAdd_Table_Fields (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
 
CSG_ParameterAdd_Table (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
 
CSG_ParameterAdd_Table_Output (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
 
CSG_ParameterAdd_Table_List (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
 
CSG_ParameterAdd_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)
 
CSG_ParameterAdd_Shapes_Output (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
 
CSG_ParameterAdd_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_ParameterAdd_TIN (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
 
CSG_ParameterAdd_TIN_Output (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
 
CSG_ParameterAdd_TIN_List (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
 
CSG_ParameterAdd_PointCloud (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
 
CSG_ParameterAdd_PointCloud_Output (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
 
CSG_ParameterAdd_PointCloud_List (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
 
CSG_ParameterAdd_Parameters (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)
 

Friends

class CSG_Parameter
 
class CSG_Tool
 

Detailed Description

Definition at line 1649 of file parameters.h.

Constructor & Destructor Documentation

◆ CSG_Parameters() [1/4]

CSG_Parameters::CSG_Parameters ( void  )

Definition at line 65 of file parameters.cpp.

◆ ~CSG_Parameters()

CSG_Parameters::~CSG_Parameters ( void  )
virtual

Definition at line 95 of file parameters.cpp.

References Destroy().

◆ CSG_Parameters() [2/4]

CSG_Parameters::CSG_Parameters ( const CSG_Parameters Parameters)

Definition at line 71 of file parameters.cpp.

References Create().

◆ CSG_Parameters() [3/4]

CSG_Parameters::CSG_Parameters ( const SG_Char Name,
const SG_Char Description = NULL,
const SG_Char Identifier = NULL,
bool  bGrid_System = false 
)

Definition at line 79 of file parameters.cpp.

References Create().

◆ CSG_Parameters() [4/4]

CSG_Parameters::CSG_Parameters ( void *  pOwner,
const SG_Char Name,
const SG_Char Description = NULL,
const SG_Char Identifier = NULL,
bool  bGrid_System = false 
)

Definition at line 87 of file parameters.cpp.

References Create().

Member Function Documentation

◆ Add_Bool() [1/2]

CSG_Parameter * CSG_Parameters::Add_Bool ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
bool  Value = false 
)

◆ Add_Bool() [2/2]

CSG_Parameter* CSG_Parameters::Add_Bool ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
bool  Value = false 
)
inline

Definition at line 1900 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Choice() [1/2]

◆ Add_Choice() [2/2]

CSG_Parameter* CSG_Parameters::Add_Choice ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
const CSG_String Items,
int  Default = 0 
)
inline

Definition at line 1916 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Choices()

CSG_Parameter * CSG_Parameters::Add_Choices ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
const CSG_String Items 
)

◆ Add_Color() [1/2]

CSG_Parameter * CSG_Parameters::Add_Color ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Value = 0 
)

Definition at line 426 of file parameters.cpp.

References Add_Value(), and PARAMETER_TYPE_Color.

Referenced by CSG_Tool_Chain::Create().

◆ Add_Color() [2/2]

CSG_Parameter* CSG_Parameters::Add_Color ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Value = 0 
)
inline

Definition at line 1910 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Colors() [1/2]

CSG_Parameter * CSG_Parameters::Add_Colors ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
CSG_Colors pInit = NULL 
)

◆ Add_Colors() [2/2]

CSG_Parameter* CSG_Parameters::Add_Colors ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
CSG_Colors pInit = NULL 
)
inline

Definition at line 1926 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Data_Type()

CSG_Parameter * CSG_Parameters::Add_Data_Type ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Data_Types,
TSG_Data_Type  Default = SG_DATATYPE_Undefined,
const CSG_String User = "" 
)

Add a parameter for selecting a data type from a list of choices. The Data_Types argument expects a combination of data type flags as defined in <api_core.h>, e.g. SG_DATATYPES_Integer or SG_DATATYPES_Numeric. You can add an additional choice with the User argument, e.g. to offer a type related to an selected input data set.

Definition at line 452 of file parameters.cpp.

References CSG_Parameter::asDataType(), PARAMETER_TYPE_Data_Type, Set_Callback(), and CSG_Parameter_Data_Type::Set_Data_Types().

◆ Add_Date() [1/2]

CSG_Parameter * CSG_Parameters::Add_Date ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
double  Value = 0.0 
)

◆ Add_Date() [2/2]

CSG_Parameter* CSG_Parameters::Add_Date ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
double  Value = 0.0 
)
inline

Definition at line 1908 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Degree() [1/2]

CSG_Parameter * CSG_Parameters::Add_Degree ( 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 
)

Definition at line 411 of file parameters.cpp.

References Add_Value(), and PARAMETER_TYPE_Degree.

Referenced by CSG_Tool_Chain::Create().

◆ Add_Degree() [2/2]

CSG_Parameter* CSG_Parameters::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 
)
inline

Definition at line 1906 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Double() [1/2]

CSG_Parameter * CSG_Parameters::Add_Double ( 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 
)

◆ Add_Double() [2/2]

CSG_Parameter* CSG_Parameters::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 
)
inline

Definition at line 1904 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_FilePath() [1/2]

CSG_Parameter * CSG_Parameters::Add_FilePath ( const CSG_String ParentID,
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 
)

◆ Add_FilePath() [2/2]

CSG_Parameter* CSG_Parameters::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 
)
inline

Definition at line 1922 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_FixedTable() [1/2]

CSG_Parameter * CSG_Parameters::Add_FixedTable ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
CSG_Table pInit = NULL 
)

◆ Add_FixedTable() [2/2]

CSG_Parameter* CSG_Parameters::Add_FixedTable ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
CSG_Table pInit = NULL 
)
inline

Definition at line 1928 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Font() [1/2]

CSG_Parameter * CSG_Parameters::Add_Font ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
const SG_Char pInit = NULL 
)

◆ Add_Font() [2/2]

CSG_Parameter* CSG_Parameters::Add_Font ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
const SG_Char pInit = NULL 
)
inline

Definition at line 1924 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Grid() [1/2]

CSG_Parameter * CSG_Parameters::Add_Grid ( const CSG_String ParentID,
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 
)

◆ Add_Grid() [2/2]

CSG_Parameter* CSG_Parameters::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 
)
inline

◆ Add_Grid_List() [1/2]

CSG_Parameter * CSG_Parameters::Add_Grid_List ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Constraint,
bool  bSystem_Dependent = true 
)

◆ Add_Grid_List() [2/2]

CSG_Parameter* CSG_Parameters::Add_Grid_List ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Constraint,
bool  bSystem_Dependent = true 
)
inline

Definition at line 1938 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Grid_or_Const() [1/2]

CSG_Parameter * CSG_Parameters::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 
)

Definition at line 610 of file parameters.cpp.

References Add_Grid(), and PARAMETER_INPUT_OPTIONAL.

◆ Add_Grid_or_Const() [2/2]

CSG_Parameter* CSG_Parameters::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 
)
inline

Definition at line 1934 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Grid_Output() [1/2]

CSG_Parameter * CSG_Parameters::Add_Grid_Output ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description 
)

◆ Add_Grid_Output() [2/2]

CSG_Parameter* CSG_Parameters::Add_Grid_Output ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description 
)
inline

Definition at line 1936 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Grid_System() [1/2]

CSG_Parameter * CSG_Parameters::Add_Grid_System ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
CSG_Grid_System pInit = NULL 
)

◆ Add_Grid_System() [2/2]

CSG_Parameter* CSG_Parameters::Add_Grid_System ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
CSG_Grid_System pInit = NULL 
)
inline

Definition at line 1930 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Grids()

CSG_Parameter * CSG_Parameters::Add_Grids ( const CSG_String ParentID,
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 
)

◆ Add_Grids_List()

CSG_Parameter * CSG_Parameters::Add_Grids_List ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Constraint,
bool  bSystem_Dependent = true 
)

◆ Add_Grids_Output()

CSG_Parameter * CSG_Parameters::Add_Grids_Output ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description 
)

◆ Add_Info_Range() [1/2]

CSG_Parameter * CSG_Parameters::Add_Info_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 
)

Definition at line 437 of file parameters.cpp.

◆ Add_Info_Range() [2/2]

CSG_Parameter* CSG_Parameters::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 
)
inline

Definition at line 1914 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Info_String() [1/2]

CSG_Parameter * CSG_Parameters::Add_Info_String ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
const CSG_String String,
bool  bLongText = false 
)

Definition at line 494 of file parameters.cpp.

◆ Add_Info_String() [2/2]

CSG_Parameter* CSG_Parameters::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 
)
inline

Definition at line 1920 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Info_Value() [1/2]

CSG_Parameter * CSG_Parameters::Add_Info_Value ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
TSG_Parameter_Type  Type,
double  Value = 0.0 
)

Definition at line 390 of file parameters.cpp.

Referenced by CSG_Parameter_Range::CSG_Parameter_Range().

◆ Add_Info_Value() [2/2]

CSG_Parameter* CSG_Parameters::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 
)
inline

Definition at line 1898 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Int() [1/2]

CSG_Parameter * CSG_Parameters::Add_Int ( const CSG_String ParentID,
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 
)

◆ Add_Int() [2/2]

CSG_Parameter* CSG_Parameters::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 
)
inline

Definition at line 1902 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Node() [1/2]

CSG_Parameter * CSG_Parameters::Add_Node ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description 
)

◆ Add_Node() [2/2]

CSG_Parameter* CSG_Parameters::Add_Node ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description 
)
inline

Definition at line 1894 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Parameter()

CSG_Parameter * CSG_Parameters::Add_Parameter ( CSG_Parameter pParameter)

Definition at line 365 of file parameters.cpp.

◆ Add_Parameters() [1/2]

CSG_Parameter * CSG_Parameters::Add_Parameters ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description 
)

Definition at line 923 of file parameters.cpp.

References CSG_Parameter::asParameters(), and PARAMETER_TYPE_Parameters.

◆ Add_Parameters() [2/2]

CSG_Parameter* CSG_Parameters::Add_Parameters ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description 
)
inline

Definition at line 1970 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_PointCloud() [1/2]

CSG_Parameter * CSG_Parameters::Add_PointCloud ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Constraint 
)

Definition at line 886 of file parameters.cpp.

References PARAMETER_TYPE_PointCloud.

Referenced by CSG_Tool_Chain::Create().

◆ Add_PointCloud() [2/2]

CSG_Parameter* CSG_Parameters::Add_PointCloud ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Constraint 
)
inline

◆ Add_PointCloud_List() [1/2]

CSG_Parameter * CSG_Parameters::Add_PointCloud_List ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Constraint 
)

Definition at line 908 of file parameters.cpp.

References PARAMETER_TYPE_PointCloud_List.

Referenced by CSG_Tool_Chain::Create().

◆ Add_PointCloud_List() [2/2]

CSG_Parameter* CSG_Parameters::Add_PointCloud_List ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Constraint 
)
inline

Definition at line 1968 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_PointCloud_Output() [1/2]

CSG_Parameter * CSG_Parameters::Add_PointCloud_Output ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description 
)

◆ Add_PointCloud_Output() [2/2]

CSG_Parameter* CSG_Parameters::Add_PointCloud_Output ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description 
)
inline

Definition at line 1966 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Range() [1/2]

CSG_Parameter * CSG_Parameters::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 
)

Definition at line 432 of file parameters.cpp.

Referenced by CSG_Tool_Chain::Create().

◆ Add_Range() [2/2]

CSG_Parameter* CSG_Parameters::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 
)
inline

Definition at line 1912 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Reference() [1/2]

void CSG_Parameters::Add_Reference ( const CSG_String Authors,
const CSG_String Year,
const CSG_String Title,
const CSG_String Where,
const SG_Char Link = NULL,
const SG_Char Link_Text = NULL 
)

Add a reference to the list of references.

Definition at line 292 of file parameters.cpp.

References CSG_String::Format(), CSG_String::is_Empty(), and CSG_Strings::Sort().

Referenced by CSG_Tool::Add_Reference().

◆ Add_Reference() [2/2]

void CSG_Parameters::Add_Reference ( const CSG_String Link,
const SG_Char Link_Text = NULL 
)

Add a reference to the list of references.

Definition at line 314 of file parameters.cpp.

References CSG_String::c_str(), CSG_String::Format(), and CSG_Strings::Sort().

◆ Add_Shapes() [1/2]

CSG_Parameter * CSG_Parameters::Add_Shapes ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Constraint,
TSG_Shape_Type  Shape_Type = SHAPE_TYPE_Undefined 
)

Definition at line 808 of file parameters.cpp.

References PARAMETER_TYPE_Shapes.

Referenced by CSG_Tool_Chain::Create().

◆ Add_Shapes() [2/2]

CSG_Parameter* CSG_Parameters::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 
)
inline

◆ Add_Shapes_List() [1/2]

CSG_Parameter * CSG_Parameters::Add_Shapes_List ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Constraint,
TSG_Shape_Type  Type = SHAPE_TYPE_Undefined 
)

Definition at line 832 of file parameters.cpp.

References PARAMETER_TYPE_Shapes_List.

Referenced by CSG_Tool_Chain::Create().

◆ Add_Shapes_List() [2/2]

CSG_Parameter* CSG_Parameters::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 
)
inline

Definition at line 1956 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Shapes_Output() [1/2]

CSG_Parameter * CSG_Parameters::Add_Shapes_Output ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description 
)

◆ Add_Shapes_Output() [2/2]

CSG_Parameter* CSG_Parameters::Add_Shapes_Output ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description 
)
inline

Definition at line 1954 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_String() [1/2]

CSG_Parameter * CSG_Parameters::Add_String ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
const CSG_String String,
bool  bLongText = false,
bool  bPassword = false 
)

Definition at line 489 of file parameters.cpp.

Referenced by CSG_Tool_Chain::Create().

◆ Add_String() [2/2]

CSG_Parameter* CSG_Parameters::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 
)
inline

Definition at line 1918 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Table() [1/2]

CSG_Parameter * CSG_Parameters::Add_Table ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Constraint 
)

Definition at line 771 of file parameters.cpp.

References PARAMETER_TYPE_Table.

Referenced by CSG_Tool_Chain::Create().

◆ Add_Table() [2/2]

CSG_Parameter* CSG_Parameters::Add_Table ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Constraint 
)
inline

◆ Add_Table_Field() [1/2]

CSG_Parameter * CSG_Parameters::Add_Table_Field ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
bool  bAllowNone = false 
)

◆ Add_Table_Field() [2/2]

CSG_Parameter* CSG_Parameters::Add_Table_Field ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
bool  bAllowNone = false 
)
inline

Definition at line 1940 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Table_Field_or_Const() [1/2]

CSG_Parameter * CSG_Parameters::Add_Table_Field_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 
)

Definition at line 741 of file parameters.cpp.

References Add_Table_Field().

◆ Add_Table_Field_or_Const() [2/2]

CSG_Parameter* CSG_Parameters::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 
)
inline

Definition at line 1942 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Table_Fields() [1/2]

CSG_Parameter * CSG_Parameters::Add_Table_Fields ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description 
)

◆ Add_Table_Fields() [2/2]

CSG_Parameter* CSG_Parameters::Add_Table_Fields ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description 
)
inline

Definition at line 1944 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Table_List() [1/2]

CSG_Parameter * CSG_Parameters::Add_Table_List ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Constraint 
)

Definition at line 793 of file parameters.cpp.

References PARAMETER_TYPE_Table_List.

Referenced by CSG_Tool_Chain::Create().

◆ Add_Table_List() [2/2]

CSG_Parameter* CSG_Parameters::Add_Table_List ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Constraint 
)
inline

Definition at line 1950 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Table_Output() [1/2]

CSG_Parameter * CSG_Parameters::Add_Table_Output ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description 
)

◆ Add_Table_Output() [2/2]

CSG_Parameter* CSG_Parameters::Add_Table_Output ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description 
)
inline

Definition at line 1948 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_TIN() [1/2]

CSG_Parameter * CSG_Parameters::Add_TIN ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Constraint 
)

Definition at line 849 of file parameters.cpp.

References PARAMETER_TYPE_TIN.

Referenced by CSG_Tool_Chain::Create().

◆ Add_TIN() [2/2]

CSG_Parameter* CSG_Parameters::Add_TIN ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Constraint 
)
inline

Definition at line 1958 of file parameters.h.

References CSG_Data_Manager::Add_TIN(), CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_TIN_List() [1/2]

CSG_Parameter * CSG_Parameters::Add_TIN_List ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Constraint 
)

Definition at line 871 of file parameters.cpp.

References PARAMETER_TYPE_TIN_List.

Referenced by CSG_Tool_Chain::Create().

◆ Add_TIN_List() [2/2]

CSG_Parameter* CSG_Parameters::Add_TIN_List ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description,
int  Constraint 
)
inline

Definition at line 1962 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_TIN_Output() [1/2]

CSG_Parameter * CSG_Parameters::Add_TIN_Output ( const CSG_String ParentID,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description 
)

◆ Add_TIN_Output() [2/2]

CSG_Parameter* CSG_Parameters::Add_TIN_Output ( CSG_Parameter pParent,
const CSG_String ID,
const CSG_String Name,
const CSG_String Description 
)
inline

Definition at line 1960 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Value() [1/2]

CSG_Parameter * CSG_Parameters::Add_Value ( const CSG_String ParentID,
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 
)

Following parameter types can be used: PARAMETER_TYPE_Bool PARAMETER_TYPE_Int PARAMETER_TYPE_Double PARAMETER_TYPE_Degree PARAMETER_TYPE_Color

Definition at line 385 of file parameters.cpp.

Referenced by Add_Bool(), Add_Color(), Add_Date(), Add_Degree(), Add_Double(), and Add_Int().

◆ Add_Value() [2/2]

CSG_Parameter* CSG_Parameters::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 
)
inline

Definition at line 1896 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Assign()

bool CSG_Parameters::Assign ( CSG_Parameters pSource)

Definition at line 1453 of file parameters.cpp.

References Create().

Referenced by CSG_Parameter_Parameters::_Assign().

◆ Assign_Parameters()

bool CSG_Parameters::Assign_Parameters ( CSG_Parameters pSource)

◆ Assign_Values()

bool CSG_Parameters::Assign_Values ( CSG_Parameters pSource)

◆ Cmp_Identifier()

bool CSG_Parameters::Cmp_Identifier ( const CSG_String Identifier) const

Change the identifier of this parameter list after construction.

Definition at line 262 of file parameters.cpp.

References CSG_String::Cmp().

Referenced by Get_Parameter().

◆ Create() [1/3]

◆ Create() [2/3]

bool CSG_Parameters::Create ( const SG_Char Name,
const SG_Char Description = NULL,
const SG_Char Identifier = NULL,
bool  bGrid_System = false 
)

◆ Create() [3/3]

bool CSG_Parameters::Create ( void *  pOwner,
const SG_Char Name,
const SG_Char Description = NULL,
const SG_Char Identifier = NULL,
bool  bGrid_System = false 
)

Definition at line 169 of file parameters.cpp.

References Create().

◆ DataObjects_Check()

bool CSG_Parameters::DataObjects_Check ( bool  bSilent = false)

◆ Del_Parameter() [1/2]

bool CSG_Parameters::Del_Parameter ( const CSG_String ID)

Definition at line 1238 of file parameters.cpp.

References CSG_String::Cmp(), Del_Parameter(), and CSG_String::Length().

◆ Del_Parameter() [2/2]

◆ Del_Parameters()

bool CSG_Parameters::Del_Parameters ( void  )

Definition at line 1255 of file parameters.cpp.

References SG_Free().

Referenced by Assign_Parameters(), and Destroy().

◆ Del_References()

void CSG_Parameters::Del_References ( void  )

Delete all references.

Definition at line 326 of file parameters.cpp.

References CSG_Strings::Clear().

◆ Destroy()

void CSG_Parameters::Destroy ( void  )

Definition at line 182 of file parameters.cpp.

References CSG_Strings::Clear(), and Del_Parameters().

Referenced by Create(), and ~CSG_Parameters().

◆ Get_Count()

◆ Get_Description()

const CSG_String& CSG_Parameters::Get_Description ( void  ) const
inline

Definition at line 1691 of file parameters.h.

Referenced by Create(), and CSG_Tool::Get_Description().

◆ Get_Grid_System()

CSG_Grid_System* CSG_Parameters::Get_Grid_System ( void  ) const
inline

Definition at line 1847 of file parameters.h.

Referenced by CSG_Tool::Get_Grid_System(), and CSG_Tool_Grid::Set_System().

◆ Get_Grid_System_Parameter()

CSG_Parameter* CSG_Parameters::Get_Grid_System_Parameter ( void  ) const
inline

Definition at line 1846 of file parameters.h.

◆ Get_Identifier()

◆ Get_Manager()

class CSG_Data_Manager* CSG_Parameters::Get_Manager ( void  ) const
inline

◆ Get_Name()

const CSG_String& CSG_Parameters::Get_Name ( void  ) const
inline

Definition at line 1688 of file parameters.h.

Referenced by Create(), DataObjects_Check(), and CSG_Tool::Get_Name().

◆ Get_Owner()

void* CSG_Parameters::Get_Owner ( void  ) const
inline

Definition at line 1670 of file parameters.h.

Referenced by CSG_Parameter_Parameters::CSG_Parameter_Parameters(), and has_GUI().

◆ Get_Parameter() [1/2]

◆ Get_Parameter() [2/2]

◆ Get_References()

const CSG_Strings& CSG_Parameters::Get_References ( void  ) const
inline

Definition at line 1696 of file parameters.h.

Referenced by CSG_Tool::Get_References().

◆ Get_String()

◆ Get_Tool()

◆ has_GUI()

bool CSG_Parameters::has_GUI ( void  ) const

If parameters are owned by a tool the function returns the tool's GUI mode, or the presence of a GUI frame otherwise.

Definition at line 242 of file parameters.cpp.

References Get_Owner(), Get_Tool(), and SG_UI_Get_Window_Main().

Referenced by CSG_Parameter::is_Enabled(), and CSG_Parameter_Grid_List::Update_Data().

◆ is_Managed()

bool CSG_Parameters::is_Managed ( void  ) const
inline

Definition at line 1844 of file parameters.h.

Referenced by CSG_Tool::Dlg_Parameters().

◆ Load() [1/2]

◆ Load() [2/2]

bool CSG_Parameters::Load ( const CSG_String File)

Definition at line 2068 of file parameters.cpp.

References Load(), and CSG_MetaData::Load().

◆ Msg_String()

bool CSG_Parameters::Msg_String ( bool  bOptionsOnly)

◆ operator()() [1/4]

CSG_Parameter* CSG_Parameters::operator() ( const char *  ID) const
inline

Definition at line 1713 of file parameters.h.

◆ operator()() [2/4]

CSG_Parameter* CSG_Parameters::operator() ( const CSG_String ID) const
inline

Definition at line 1712 of file parameters.h.

◆ operator()() [3/4]

CSG_Parameter* CSG_Parameters::operator() ( const wchar_t *  ID) const
inline

Definition at line 1714 of file parameters.h.

◆ operator()() [4/4]

CSG_Parameter* CSG_Parameters::operator() ( int  i) const
inline

Definition at line 1711 of file parameters.h.

◆ operator=()

CSG_Parameters& CSG_Parameters::operator= ( const CSG_Parameters Parameters)
inline

Definition at line 1706 of file parameters.h.

◆ operator[]() [1/4]

CSG_Parameter& CSG_Parameters::operator[] ( const char *  ID) const
inline

Definition at line 1718 of file parameters.h.

◆ operator[]() [2/4]

CSG_Parameter& CSG_Parameters::operator[] ( const CSG_String ID) const
inline

Definition at line 1717 of file parameters.h.

◆ operator[]() [3/4]

CSG_Parameter& CSG_Parameters::operator[] ( const wchar_t *  ID) const
inline

Definition at line 1719 of file parameters.h.

◆ operator[]() [4/4]

CSG_Parameter& CSG_Parameters::operator[] ( int  i) const
inline

Definition at line 1716 of file parameters.h.

◆ Reset_Grid_System()

bool CSG_Parameters::Reset_Grid_System ( void  )

Resets the parameters' grid system if it has one. This is typically the case, if it represents the parameters list of a CSG_Tool_Grid object.

Definition at line 2014 of file parameters.cpp.

References Set_Grid_System().

Referenced by CSG_Tool::Reset_Grid_System().

◆ Restore_Defaults()

◆ Save() [1/2]

bool CSG_Parameters::Save ( const CSG_String File) const

Definition at line 2074 of file parameters.cpp.

References CSG_MetaData::Save(), and Save().

◆ Save() [2/2]

bool CSG_Parameters::Save ( CSG_MetaData Data) const

◆ Serialize() [1/4]

bool CSG_Parameters::Serialize ( const CSG_String File) const
inline

Definition at line 1831 of file parameters.h.

◆ Serialize() [2/4]

bool CSG_Parameters::Serialize ( const CSG_String File,
bool  bSave 
)
inline

Definition at line 1830 of file parameters.h.

◆ Serialize() [3/4]

bool CSG_Parameters::Serialize ( CSG_MetaData Data) const
inline

Definition at line 1829 of file parameters.h.

◆ Serialize() [4/4]

bool CSG_Parameters::Serialize ( CSG_MetaData Data,
bool  bSave 
)
inline

Definition at line 1828 of file parameters.h.

Referenced by CSG_Parameter_Parameters::_Serialize().

◆ Serialize_Compatibility()

◆ Set_Callback()

◆ Set_Callback_On_Parameter_Changed()

◆ Set_Description()

void CSG_Parameters::Set_Description ( const CSG_String Description)

Change the description for this parameter list after construction.

Definition at line 282 of file parameters.cpp.

Referenced by Create(), and CSG_Tool::Set_Description().

◆ Set_Enabled() [1/2]

◆ Set_Enabled() [2/2]

void CSG_Parameters::Set_Enabled ( const CSG_String Identifier,
bool  bEnabled = true 
)

Enable or disable parameter with given identifier.

Definition at line 349 of file parameters.cpp.

References Get_Parameter(), and CSG_Parameter::Set_Enabled().

◆ Set_Grid_System()

bool CSG_Parameters::Set_Grid_System ( const CSG_Grid_System System)

Sets the parameters' grid system if it has one. This is typically the case, if it represents the parameters list of a CSG_Tool_Grid object.

Definition at line 2003 of file parameters.cpp.

References CSG_Parameter::asGrid_System(), and CSG_Parameter::Set_Value().

Referenced by Reset_Grid_System(), and CSG_Tool::Set_Grid_System().

◆ Set_History()

◆ Set_Identifier()

void CSG_Parameters::Set_Identifier ( const CSG_String Identifier)

Change the identifier of this parameter list after construction.

Definition at line 252 of file parameters.cpp.

Referenced by Create().

◆ Set_Manager()

void CSG_Parameters::Set_Manager ( class CSG_Data_Manager pManager)

Set the responsible data manager for this parameter list. If it is not NULL, the parameter list will perform checks beforehand tool executions, e.g. check if all data sets in its parameter list are really loaded.

Definition at line 206 of file parameters.cpp.

References CSG_Parameter::asParameters(), Get_Count(), PARAMETER_TYPE_Parameters, and Set_Manager().

Referenced by Set_Manager(), CSG_Tool::Set_Manager(), CSG_Tool::Settings_Pop(), and CSG_Tool::Settings_Push().

◆ Set_Name()

void CSG_Parameters::Set_Name ( const CSG_String Name)

Change the name of this parameter list after construction.

Definition at line 272 of file parameters.cpp.

Referenced by Create(), and CSG_Tool::Set_Name().

◆ Set_Parameter() [1/24]

bool CSG_Parameters::Set_Parameter ( const char *  ID,
const char *  Value,
int  Type = PARAMETER_TYPE_Undefined 
)

Definition at line 1407 of file parameters.cpp.

References Set_Parameter().

◆ Set_Parameter() [2/24]

bool CSG_Parameters::Set_Parameter ( const char *  ID,
const CSG_String Value,
int  Type = PARAMETER_TYPE_Undefined 
)

Definition at line 1396 of file parameters.cpp.

References Set_Parameter().

◆ Set_Parameter() [3/24]

bool CSG_Parameters::Set_Parameter ( const char *  ID,
const wchar_t *  Value,
int  Type = PARAMETER_TYPE_Undefined 
)

Definition at line 1412 of file parameters.cpp.

References Set_Parameter().

◆ Set_Parameter() [4/24]

bool CSG_Parameters::Set_Parameter ( const char *  ID,
CSG_Data_Object Value,
int  Type = PARAMETER_TYPE_Undefined 
)

Definition at line 1366 of file parameters.cpp.

References Set_Parameter().

◆ Set_Parameter() [5/24]

bool CSG_Parameters::Set_Parameter ( const char *  ID,
CSG_Parameter pValue 
)

Definition at line 1346 of file parameters.cpp.

References Set_Parameter().

◆ Set_Parameter() [6/24]

bool CSG_Parameters::Set_Parameter ( const char *  ID,
double  Value,
int  Type = PARAMETER_TYPE_Undefined 
)

Definition at line 1386 of file parameters.cpp.

References Set_Parameter().

◆ Set_Parameter() [7/24]

bool CSG_Parameters::Set_Parameter ( const char *  ID,
int  Value,
int  Type = PARAMETER_TYPE_Undefined 
)

Definition at line 1376 of file parameters.cpp.

References Set_Parameter().

◆ Set_Parameter() [8/24]

bool CSG_Parameters::Set_Parameter ( const char *  ID,
void *  Value,
int  Type = PARAMETER_TYPE_Undefined 
)

Definition at line 1356 of file parameters.cpp.

References Set_Parameter().

◆ Set_Parameter() [9/24]

bool CSG_Parameters::Set_Parameter ( const CSG_String ID,
const char *  Value,
int  Type = PARAMETER_TYPE_Undefined 
)

Definition at line 1406 of file parameters.cpp.

References Set_Parameter().

◆ Set_Parameter() [10/24]

bool CSG_Parameters::Set_Parameter ( const CSG_String ID,
const CSG_String Value,
int  Type = PARAMETER_TYPE_Undefined 
)

◆ Set_Parameter() [11/24]

bool CSG_Parameters::Set_Parameter ( const CSG_String ID,
const wchar_t *  Value,
int  Type = PARAMETER_TYPE_Undefined 
)

Definition at line 1411 of file parameters.cpp.

References Set_Parameter().

◆ Set_Parameter() [12/24]

bool CSG_Parameters::Set_Parameter ( const CSG_String ID,
CSG_Data_Object Value,
int  Type = PARAMETER_TYPE_Undefined 
)

◆ Set_Parameter() [13/24]

◆ Set_Parameter() [14/24]

bool CSG_Parameters::Set_Parameter ( const CSG_String ID,
double  Value,
int  Type = PARAMETER_TYPE_Undefined 
)

◆ Set_Parameter() [15/24]

bool CSG_Parameters::Set_Parameter ( const CSG_String ID,
int  Value,
int  Type = PARAMETER_TYPE_Undefined 
)

◆ Set_Parameter() [16/24]

bool CSG_Parameters::Set_Parameter ( const CSG_String ID,
void *  Value,
int  Type = PARAMETER_TYPE_Undefined 
)

◆ Set_Parameter() [17/24]

bool CSG_Parameters::Set_Parameter ( const wchar_t *  ID,
const char *  Value,
int  Type = PARAMETER_TYPE_Undefined 
)

Definition at line 1408 of file parameters.cpp.

References Set_Parameter().

◆ Set_Parameter() [18/24]

bool CSG_Parameters::Set_Parameter ( const wchar_t *  ID,
const CSG_String Value,
int  Type = PARAMETER_TYPE_Undefined 
)

Definition at line 1397 of file parameters.cpp.

References Set_Parameter().

◆ Set_Parameter() [19/24]

bool CSG_Parameters::Set_Parameter ( const wchar_t *  ID,
const wchar_t *  Value,
int  Type = PARAMETER_TYPE_Undefined 
)

Definition at line 1413 of file parameters.cpp.

References Set_Parameter().

◆ Set_Parameter() [20/24]

bool CSG_Parameters::Set_Parameter ( const wchar_t *  ID,
CSG_Data_Object Value,
int  Type = PARAMETER_TYPE_Undefined 
)

Definition at line 1367 of file parameters.cpp.

References Set_Parameter().

◆ Set_Parameter() [21/24]

bool CSG_Parameters::Set_Parameter ( const wchar_t *  ID,
CSG_Parameter pValue 
)

Definition at line 1347 of file parameters.cpp.

References Set_Parameter().

◆ Set_Parameter() [22/24]

bool CSG_Parameters::Set_Parameter ( const wchar_t *  ID,
double  Value,
int  Type = PARAMETER_TYPE_Undefined 
)

Definition at line 1387 of file parameters.cpp.

References Set_Parameter().

◆ Set_Parameter() [23/24]

bool CSG_Parameters::Set_Parameter ( const wchar_t *  ID,
int  Value,
int  Type = PARAMETER_TYPE_Undefined 
)

Definition at line 1377 of file parameters.cpp.

References Set_Parameter().

◆ Set_Parameter() [24/24]

bool CSG_Parameters::Set_Parameter ( const wchar_t *  ID,
void *  Value,
int  Type = PARAMETER_TYPE_Undefined 
)

Definition at line 1357 of file parameters.cpp.

References Set_Parameter().

◆ Use_Grid_System()

bool CSG_Parameters::Use_Grid_System ( void  )

Let parameters list provide a default grid system after construction.

Definition at line 224 of file parameters.cpp.

References _TL, and Add_Grid_System().

Referenced by Create(), and CSG_Tool_Grid::CSG_Tool_Grid().

Friends And Related Function Documentation

◆ CSG_Parameter

friend class CSG_Parameter
friend

Definition at line 1651 of file parameters.h.

◆ CSG_Tool

friend class CSG_Tool
friend

Definition at line 1652 of file parameters.h.


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