#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_Tool *	Get_Tool (void) const

void	Set_Tool (class CSG_Tool *pTool)

class CSG_Data_Manager *	Get_Manager (void) const

void	Set_Manager (class CSG_Data_Manager *pManager)

bool	Push (class CSG_Data_Manager *pManager=NULL, bool bRestoreDefaults=true)

bool	Pop (void)

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_String &	Get_Identifier (void) const

void	Set_Name (const CSG_String &Name)

const CSG_String &	Get_Name (void) const

void	Set_Description (const CSG_String &Description)

const CSG_String &	Get_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_Strings &	Get_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_Parameters &	operator= (const CSG_Parameters &Parameters)

CSG_Parameter *	Get_Parameter (int i) const

CSG_Parameter *	Get_Parameter (int i, bool MsgOnError) const

CSG_Parameter *	Get_Parameter (const CSG_String &ID, bool MsgOnError=false) const

CSG_Parameter *	Get_Parameter (const char *ID, bool MsgOnError=false) const

CSG_Parameter *	Get_Parameter (const wchar_t *ID, bool MsgOnError=false) const

CSG_Parameter *	operator() (int i) const

CSG_Parameter *	operator() (const CSG_String &ID) const

CSG_Parameter *	operator() (const char *ID) const

CSG_Parameter *	operator() (const wchar_t *ID) const

CSG_Parameter &	operator[] (int i) const

CSG_Parameter &	operator[] (const CSG_String &ID) const

CSG_Parameter &	operator[] (const char *ID) const

CSG_Parameter &	operator[] (const wchar_t *ID) const

bool	Del_Parameter (int i)

bool	Del_Parameter (const CSG_String &ID)

bool	Del_Parameters (void)

CSG_Parameter *	Add_Parameter (CSG_Parameter *pParameter)

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

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

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

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

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

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

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

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

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

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)

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

CSG_Parameter *	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="")

CSG_Parameter *	Add_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_Parameter *	Add_Choices (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, const CSG_String &Items)

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

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

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

CSG_Parameter *	Add_Colors (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Palette=0, int nColors=11, bool bRevert=false)

CSG_Parameter *	Add_Colors (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, CSG_Colors *pInit)

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

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

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

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

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)

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

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

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

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

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

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

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

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

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

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

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

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

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

CSG_Parameter *	Add_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_Parameter *	Add_TIN (const CSG_String &ParentID, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)

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

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

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

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

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

CSG_Parameter *	Add_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_Parameter *	Get_Grid_System_Parameter (void) const

CSG_Grid_System *	Get_Grid_System (void) const

bool	Set_Grid_System (const CSG_Grid_System &System)

bool	Reset_Grid_System (void)

CSG_Parameter *	Add_Node (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)

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)

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)

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

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)

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_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 *	Add_Date (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, double Value=0.0)

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

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)

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_Choice (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, const CSG_String &Items, int Default=0)

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)

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)

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_Parameter *	Add_Font (CSG_Parameter pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, const SG_Char pInit=NULL)

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

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

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)

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_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_Parameter *	Add_Grid_Output (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)

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)

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

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)

CSG_Parameter *	Add_Table_Fields (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)

CSG_Parameter *	Add_Table (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)

CSG_Parameter *	Add_Table_Output (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)

CSG_Parameter *	Add_Table_List (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)

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)

CSG_Parameter *	Add_Shapes_Output (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)

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_TIN (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)

CSG_Parameter *	Add_TIN_Output (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)

CSG_Parameter *	Add_TIN_List (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)

CSG_Parameter *	Add_PointCloud (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)

CSG_Parameter *	Add_PointCloud_Output (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description)

CSG_Parameter *	Add_PointCloud_List (CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)

CSG_Parameter *	Add_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 1689 of file parameters.h.

Constructor & Destructor Documentation

◆ CSG_Parameters() [1/4]

CSG_Parameters::CSG_Parameters ( void )

Definition at line 65 of file parameters.cpp.

Referenced by Push().

◆ ~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`
	)

Definition at line 465 of file parameters.cpp.

References Add_Value(), and PARAMETER_TYPE_Bool.

Referenced by CSG_Parameters_Grid_Target::Add_Grid(), CSG_Parameters_Grid_Target::Add_Grids(), CSG_Distance_Weighting::Add_Parameters(), and CSG_Tool_Chain::Create().

◆ 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 1950 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Choice() [1/2]

CSG_Parameter * CSG_Parameters::Add_Choice	(	const CSG_String &	ParentID,
		const CSG_String &	ID,
		const CSG_String &	Name,
		const CSG_String &	Description,
		const CSG_String &	Items,
		int	Default = `0`
	)

Definition at line 533 of file parameters.cpp.

References CSG_Parameter::asChoice(), PARAMETER_TYPE_Choice, Set_Callback(), CSG_Parameter::Set_Default(), CSG_Parameter_Choice::Set_Items(), and CSG_Parameter::Set_Value().

Referenced by CSG_Distance_Weighting::Add_Parameters(), CSG_Grid_Cell_Addressor::Add_Parameters(), CSG_Parameters_Point_Search::Create(), CSG_Tool_Chain::Create(), and CSG_Parameters_Grid_Target::Create().

◆ 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 1966 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
	)

Definition at line 548 of file parameters.cpp.

References CSG_Parameter::asChoices(), PARAMETER_TYPE_Choices, and CSG_Parameter_Choices::Set_Items().

Referenced by CSG_Tool_Chain::Create().

◆ 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 495 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 1960 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Add_Colors() [1/3]

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
	)

Definition at line 596 of file parameters.cpp.

References CSG_Parameter::asColors(), CSG_Colors::Create(), and PARAMETER_TYPE_Colors.

◆ Add_Colors() [2/3]

CSG_Parameter * CSG_Parameters::Add_Colors	(	const CSG_String &	ParentID,
		const CSG_String &	ID,
		const CSG_String &	Name,
		const CSG_String &	Description,
		int	Palette = `0`,
		int	nColors = `11`,
		bool	bRevert = `false`
	)

Definition at line 587 of file parameters.cpp.

References CSG_Parameter::asColors(), CSG_Colors::Create(), and PARAMETER_TYPE_Colors.

Referenced by CSG_Tool_Chain::Create().

◆ Add_Colors() [3/3]

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 1976 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 521 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`
	)

Definition at line 485 of file parameters.cpp.

References Add_Value(), CSG_DateTime::Get_JDN(), CSG_DateTime::Now(), and PARAMETER_TYPE_Date.

Referenced by CSG_Tool_Chain::Create().

◆ 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 1958 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 480 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 1956 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`
	)

Definition at line 475 of file parameters.cpp.

References Add_Value(), and PARAMETER_TYPE_Double.

Referenced by CSG_Parameter_Table_Field::Add_Default(), CSG_Parameter_Grid::Add_Default(), CSG_Parameters_Grid_Target::Add_Grids(), CSG_Distance_Weighting::Add_Parameters(), CSG_Grid_Cell_Addressor::Add_Parameters(), CSG_Parameters_Point_Search::Create(), CSG_Tool_Chain::Create(), CSG_Parameters_Grid_Target::Create(), and CSG_Parameter_Range::CSG_Parameter_Range().

◆ 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 1954 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`
	)

Definition at line 569 of file parameters.cpp.

References CSG_Parameter::asFilePath(), PARAMETER_TYPE_FilePath, Set_Callback(), CSG_Parameter::Set_Default(), CSG_Parameter_File_Name::Set_Filter(), CSG_Parameter_File_Name::Set_Flag_Directory(), CSG_Parameter_File_Name::Set_Flag_Multiple(), CSG_Parameter_File_Name::Set_Flag_Save(), and CSG_Parameter::Set_Value().

Referenced by CSG_Tool_Chain::Create().

◆ 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 1972 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`
	)

Definition at line 625 of file parameters.cpp.

References CSG_Table::Assign_Values(), CSG_Parameter::asTable(), CSG_Table::Create(), PARAMETER_TYPE_FixedTable, and CSG_Data_Object::Set_Name().

Referenced by CSG_Tool_Chain::Create().

◆ 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 1978 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`
	)

Definition at line 609 of file parameters.cpp.

References PARAMETER_TYPE_Font, Set_Callback(), CSG_Parameter::Set_Default(), and CSG_Parameter::Set_Value().

◆ 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 1974 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`
	)

Definition at line 655 of file parameters.cpp.

References _TL, Add_Grid_System(), CSG_Parameter::Get_Identifier(), Get_Parameter(), CSG_Parameter::Get_Type(), PARAMETER_TYPE_Grid, PARAMETER_TYPE_Grid_System, and SG_T.

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

◆ 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

Definition at line 1982 of file parameters.h.

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

◆ 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`
	)

Definition at line 701 of file parameters.cpp.

References CSG_Parameter::Get_Identifier(), Get_Parameter(), CSG_Parameter::Get_Type(), PARAMETER_OPTIONAL, PARAMETER_OUTPUT, PARAMETER_TYPE_Grid_List, and PARAMETER_TYPE_Grid_System.

Referenced by CSG_Tool_Chain::Create().

◆ 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 1988 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 681 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 1984 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
	)

Definition at line 691 of file parameters.cpp.

References PARAMETER_OUTPUT_OPTIONAL, PARAMETER_TYPE_DataObject_Output, and SG_DATAOBJECT_TYPE_Grid.

Referenced by CSG_Tool_Chain::Create().

◆ 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 1986 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`
	)

Definition at line 642 of file parameters.cpp.

References CSG_Parameter::asGrid_System(), CSG_Grid_System::Assign(), and PARAMETER_TYPE_Grid_System.

Referenced by Add_Grid(), Add_Grids(), CSG_Tool_Chain::Create(), CSG_Parameters_Grid_Target::Create(), and Use_Grid_System().

◆ 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 1980 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`
	)

Definition at line 725 of file parameters.cpp.

References _TL, Add_Grid_System(), CSG_Parameter::Get_Identifier(), Get_Parameter(), CSG_Parameter::Get_Type(), PARAMETER_TYPE_Grid_System, PARAMETER_TYPE_Grids, and SG_T.

Referenced by CSG_Parameters_Grid_Target::Add_Grids(), and CSG_Tool_Chain::Create().

◆ 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`
	)

Definition at line 761 of file parameters.cpp.

References CSG_Parameter::Get_Identifier(), Get_Parameter(), CSG_Parameter::Get_Type(), PARAMETER_OPTIONAL, PARAMETER_OUTPUT, PARAMETER_TYPE_Grid_System, and PARAMETER_TYPE_Grids_List.

Referenced by CSG_Tool_Chain::Create().

◆ 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
	)

Definition at line 751 of file parameters.cpp.

References PARAMETER_OUTPUT_OPTIONAL, PARAMETER_TYPE_DataObject_Output, and SG_DATAOBJECT_TYPE_Grids.

Referenced by CSG_Tool_Chain::Create().

◆ 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 506 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 1964 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 563 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 1970 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 459 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 1948 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`
	)

Definition at line 470 of file parameters.cpp.

References Add_Value(), and PARAMETER_TYPE_Int.

Referenced by CSG_Parameters_Grid_Target::Add_Grids(), CSG_Grid_Cell_Addressor::Add_Parameters(), CSG_Parameters_Point_Search::Create(), CSG_Tool_Chain::Create(), and CSG_Parameters_Grid_Target::Create().

◆ 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 1952 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
	)

Definition at line 440 of file parameters.cpp.

References PARAMETER_INFORMATION, and PARAMETER_TYPE_Node.

Referenced by CSG_Parameters_Grid_Target::Add_Grid(), CSG_Parameters_Grid_Target::Add_Grids(), CSG_Parameters_Point_Search::Create(), and CSG_Tool_Chain::Create().

◆ 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 1944 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 434 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 960 of file parameters.cpp.

References CSG_Parameter::asParameters(), and PARAMETER_TYPE_Parameters.

Referenced by CSG_Parameters_CRSPicker::Activate_GUI().

◆ 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 2020 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 929 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

Definition at line 2014 of file parameters.h.

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

◆ 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 947 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 2018 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
	)

Definition at line 937 of file parameters.cpp.

References PARAMETER_OUTPUT_OPTIONAL, PARAMETER_TYPE_DataObject_Output, and SG_DATAOBJECT_TYPE_PointCloud.

◆ 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 2016 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 501 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 1962 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 361 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 383 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 863 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

Definition at line 2002 of file parameters.h.

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

◆ 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 883 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 2006 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
	)

Definition at line 873 of file parameters.cpp.

References PARAMETER_OUTPUT_OPTIONAL, PARAMETER_TYPE_DataObject_Output, and SG_DATAOBJECT_TYPE_Shapes.

◆ 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 2004 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 558 of file parameters.cpp.

Referenced by CSG_Tool_Chain::Create(), and CSG_Parameters_CRSPicker::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 1968 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 832 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

Definition at line 1996 of file parameters.h.

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

◆ 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`
	)

Definition at line 785 of file parameters.cpp.

References Get_Parameter(), CSG_Parameter::Get_Type(), PARAMETER_OPTIONAL, PARAMETER_TYPE_PointCloud, PARAMETER_TYPE_Shapes, PARAMETER_TYPE_Table, PARAMETER_TYPE_Table_Field, and PARAMETER_TYPE_TIN.

Referenced by Add_Table_Field_or_Const(), and CSG_Tool_Chain::Create().

◆ 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 1990 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 802 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 1992 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
	)

Definition at line 815 of file parameters.cpp.

References Get_Parameter(), CSG_Parameter::Get_Type(), PARAMETER_TYPE_PointCloud, PARAMETER_TYPE_Shapes, PARAMETER_TYPE_Table, PARAMETER_TYPE_Table_Fields, and PARAMETER_TYPE_TIN.

Referenced by CSG_Tool_Chain::Create().

◆ 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 1994 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 850 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 2000 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
	)

Definition at line 840 of file parameters.cpp.

References PARAMETER_OUTPUT_OPTIONAL, PARAMETER_TYPE_DataObject_Output, and SG_DATAOBJECT_TYPE_Table.

◆ 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 1998 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 898 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 2008 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 916 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 2012 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
	)

Definition at line 906 of file parameters.cpp.

References PARAMETER_OUTPUT_OPTIONAL, PARAMETER_TYPE_DataObject_Output, and SG_DATAOBJECT_TYPE_TIN.

◆ 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 2010 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 454 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 1946 of file parameters.h.

References CSG_Parameter::Get_Identifier(), and SG_T.

◆ Assign()

bool CSG_Parameters::Assign ( CSG_Parameters * pSource )

Definition at line 1510 of file parameters.cpp.

References Create().

Referenced by CSG_Parameter_Parameters::_Assign().

◆ Assign_Parameters()

bool CSG_Parameters::Assign_Parameters ( CSG_Parameters * pSource )

Definition at line 1540 of file parameters.cpp.

References CSG_Parameter::asParameters(), Del_Parameters(), CSG_Parameter::Get_Identifier(), Get_Parameter(), and Set_Tool().

◆ Assign_Values()

bool CSG_Parameters::Assign_Values ( CSG_Parameters * pSource )

Definition at line 1516 of file parameters.cpp.

References CSG_Parameter::Assign(), Get_Count(), CSG_Parameter::Get_Identifier(), Get_Parameter(), and CSG_Parameter::Get_Type().

Referenced by Pop().

◆ Cmp_Identifier()

bool CSG_Parameters::Cmp_Identifier ( const CSG_String & Identifier ) const

Change the identifier of this parameter list after construction.

Definition at line 331 of file parameters.cpp.

References CSG_String::Cmp().

Referenced by Get_Parameter(), CSG_Tool::Get_Parameters(), and CSG_Parameters_Grid_Target::On_Parameter_Changed().

◆ Create() [1/3]

bool CSG_Parameters::Create ( const CSG_Parameters & Parameters )

Definition at line 124 of file parameters.cpp.

References Destroy(), Get_Description(), CSG_Parameter::Get_Identifier(), Get_Identifier(), Get_Name(), Get_Parameter(), Set_Description(), Set_Identifier(), and Set_Name().

Referenced by CSG_Parameters_CRSPicker::Activate_GUI(), CSG_Tool::Add_Parameters(), Assign(), Create(), CSG_Parameters(), and CSG_Tool::CSG_Tool().

◆ 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`
	)

Definition at line 153 of file parameters.cpp.

References Destroy(), Set_Description(), Set_Identifier(), Set_Name(), SG_T, and Use_Grid_System().

◆ 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 170 of file parameters.cpp.

References Create().

◆ DataObjects_Check()

bool CSG_Parameters::DataObjects_Check ( bool bSilent = false )

Definition at line 1574 of file parameters.cpp.

References _TL, CSG_String::Append(), CSG_String::c_str(), CSG_String::Format(), Get_Count(), Get_Name(), and SG_UI_Dlg_Message().

◆ Del_Parameter() [1/2]

bool CSG_Parameters::Del_Parameter ( const CSG_String & ID )

Definition at line 1295 of file parameters.cpp.

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

◆ Del_Parameter() [2/2]

bool CSG_Parameters::Del_Parameter ( int i )

Definition at line 1248 of file parameters.cpp.

References CSG_Parameter::Get_Child(), CSG_Parameter::Get_Children_Count(), CSG_Parameter::Get_Identifier(), CSG_Parameter::Get_Parent(), and SG_Realloc().

Referenced by CSG_Tool::DataObject_Set_Parameters(), CSG_Parameters_CRSPicker::Deactivate_GUI(), and Del_Parameter().

◆ Del_Parameters()

bool CSG_Parameters::Del_Parameters ( void )

Definition at line 1312 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 395 of file parameters.cpp.

References CSG_Strings::Clear().

◆ Destroy()

void CSG_Parameters::Destroy ( void )

Definition at line 183 of file parameters.cpp.

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

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

◆ Get_Count()

int CSG_Parameters::Get_Count ( void ) const

inline

Definition at line 1725 of file parameters.h.

Referenced by CSG_Parameter_Parameters::_Set_String(), Assign_Values(), CSG_Tool::DataObject_Update_All(), DataObjects_Check(), CSG_Parameter::Get_Description(), Get_String(), CSG_Tool::Get_Summary(), CSG_Parameter::is_Compatible(), CSG_Parameter::is_Value_Equal(), Restore_Defaults(), Save(), Set_History(), Set_Manager(), and Set_Tool().

◆ Get_Description()

const CSG_String& CSG_Parameters::Get_Description ( void ) const

inline

Definition at line 1735 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 1895 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 1894 of file parameters.h.

◆ Get_Identifier()

const CSG_String& CSG_Parameters::Get_Identifier ( void ) const

inline

Definition at line 1729 of file parameters.h.

Referenced by Create(), CSG_Parameters_Point_Search::On_Parameter_Changed(), CSG_Parameters_Grid_Target::On_Parameter_Changed(), CSG_Parameters_Point_Search::On_Parameters_Enable(), CSG_Parameters_Grid_Target::On_Parameters_Enable(), Set_History(), CSG_Parameters_Grid_Target::Set_User_Defined(), and CSG_Parameters_Grid_Target::Set_User_Defined_ZLevels().

◆ Get_Manager()

class CSG_Data_Manager* CSG_Parameters::Get_Manager ( void ) const

inline

Definition at line 1715 of file parameters.h.

Referenced by CSG_Parameter::Check(), CSG_Tool::DataObject_Add(), CSG_Tool::Execute(), CSG_Parameter::Get_Manager(), and CSG_Tool::Get_Manager().

◆ Get_Name()

const CSG_String& CSG_Parameters::Get_Name ( void ) const

inline

Definition at line 1732 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 1710 of file parameters.h.

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

◆ Get_Parameter() [1/5]

CSG_Parameter * CSG_Parameters::Get_Parameter	(	const char *	ID,
		bool	MsgOnError = `false`
	)		const

Definition at line 1193 of file parameters.cpp.

References Get_Parameter().

◆ Get_Parameter() [2/5]

CSG_Parameter * CSG_Parameters::Get_Parameter	(	const CSG_String &	ID,
		bool	MsgOnError = `false`
	)		const

◆ Get_Parameter() [3/5]

CSG_Parameter * CSG_Parameters::Get_Parameter	(	const wchar_t *	ID,
		bool	MsgOnError = `false`
	)		const

Definition at line 1194 of file parameters.cpp.

References Get_Parameter().

◆ Get_Parameter() [4/5]

CSG_Parameter* CSG_Parameters::Get_Parameter ( int i ) const

inline

Definition at line 1752 of file parameters.h.

Referenced by Add_Grid(), Add_Grid_List(), Add_Grids(), Add_Grids_List(), Add_Table_Field(), Add_Table_Fields(), Assign_Parameters(), Assign_Values(), Create(), Get_Parameter(), CSG_Parameter::is_Compatible(), CSG_Parameter::is_Value_Equal(), Load(), Serialize_Compatibility(), Set_Enabled(), Set_Parameter(), and SG_XML_Add_Parameter().

◆ Get_Parameter() [5/5]

CSG_Parameter * CSG_Parameters::Get_Parameter	(	int	i,
		bool	MsgOnError
	)		const

Definition at line 1177 of file parameters.cpp.

References _TL, CSG_String::Format(), and SG_UI_Msg_Add_Error().

◆ Get_References()

const CSG_Strings& CSG_Parameters::Get_References ( void ) const

inline

Definition at line 1740 of file parameters.h.

Referenced by CSG_Tool::Get_References().

◆ Get_String()

bool CSG_Parameters::Get_String	(	CSG_String &	String,
		bool	bOptionsOnly
	)

Definition at line 1908 of file parameters.cpp.

References CSG_Parameter::_Set_String(), CSG_Parameter::asGrid_System(), CSG_Parameter::asString(), CSG_String::c_str(), CSG_String::Format(), Get_Count(), CSG_Parameter::Get_Name(), CSG_Parameter::Get_Type(), CSG_Parameter::is_Enabled(), CSG_Parameter::is_Information(), CSG_Parameter::is_Option(), CSG_String::Left(), CSG_String::Length(), and PARAMETER_TYPE_String.

Referenced by Msg_String().

◆ Get_Tool()

class CSG_Tool* CSG_Parameters::Get_Tool ( void ) const

inline

Definition at line 1712 of file parameters.h.

Referenced by CSG_Tool::_On_Parameter_Changed(), CSG_Parameters_Grid_Target::Add_Grid(), CSG_Parameters_Grid_Target::Add_Grids(), CSG_Parameters_Grid_Target::Get_Grid(), CSG_Parameters_Grid_Target::Get_Grids(), has_GUI(), CSG_Parameters_Grid_Target::Set_User_Defined(), and CSG_Parameters_Grid_Target::Set_User_Defined_ZLevels().

◆ 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 311 of file parameters.cpp.

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

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

◆ is_Managed()

bool CSG_Parameters::is_Managed ( void ) const

inline

Definition at line 1892 of file parameters.h.

Referenced by CSG_Tool::Dlg_Parameters().

◆ Load() [1/2]

bool CSG_Parameters::Load ( const CSG_MetaData & Data )

Definition at line 2107 of file parameters.cpp.

References CSG_MetaData::Cmp_Name(), CSG_MetaData::Get_Children_Count(), Get_Parameter(), CSG_MetaData::Get_Property(), CSG_Parameter::has_Changed(), and CSG_Parameter::Serialize().

Referenced by Load().

◆ Load() [2/2]

bool CSG_Parameters::Load ( const CSG_String & File )

Definition at line 2146 of file parameters.cpp.

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

◆ Msg_String()

bool CSG_Parameters::Msg_String ( bool bOptionsOnly )

Definition at line 1942 of file parameters.cpp.

References _TL, CSG_String::c_str(), CSG_String::Format(), Get_String(), SG_UI_Msg_Add_Execution(), SG_UI_MSG_STYLE_01, and SG_UI_MSG_STYLE_NORMAL.

Referenced by CSG_Tool::Execute().

◆ operator()() [1/4]

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

inline

Definition at line 1760 of file parameters.h.

◆ operator()() [2/4]

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

inline

Definition at line 1759 of file parameters.h.

◆ operator()() [3/4]

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

inline

Definition at line 1761 of file parameters.h.

◆ operator()() [4/4]

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

inline

Definition at line 1758 of file parameters.h.

◆ operator=()

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

inline

Definition at line 1750 of file parameters.h.

◆ operator[]() [1/4]

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

inline

Definition at line 1765 of file parameters.h.

◆ operator[]() [2/4]

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

inline

Definition at line 1764 of file parameters.h.

◆ operator[]() [3/4]

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

inline

Definition at line 1766 of file parameters.h.

◆ operator[]() [4/4]

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

inline

Definition at line 1763 of file parameters.h.

◆ Pop()

bool CSG_Parameters::Pop ( void )

Restores previously pushed parameter settings and data manager.

Definition at line 285 of file parameters.cpp.

References Assign_Values().

Referenced by Destroy(), and CSG_Tool::Settings_Pop().

◆ Push()

bool CSG_Parameters::Push	(	class CSG_Data_Manager *	pManager = `NULL`,
		bool	bRestoreDefaults = `true`
	)

Stores the current parameter settings including the data manager to an internal CSG_Parameters copy. Settings and data manager can be restored by a subsequent call to Pop().

Definition at line 262 of file parameters.cpp.

References CSG_Parameters(), and Restore_Defaults().

Referenced by CSG_Tool::Settings_Push().

◆ 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 2092 of file parameters.cpp.

References Set_Grid_System().

Referenced by CSG_Tool::Reset_Grid_System().

◆ Restore_Defaults()

bool CSG_Parameters::Restore_Defaults ( bool bClearData = false )

Definition at line 1478 of file parameters.cpp.

References CSG_Parameter::asList(), DATAOBJECT_NOTSET, CSG_Parameter_List::Del_Items(), Get_Count(), CSG_Parameter::Restore_Default(), Set_Callback(), and CSG_Parameter::Set_Value().

Referenced by Push(), CSG_Tool::Reset(), and CSG_Parameter_Parameters::Restore_Default().

◆ Save() [1/2]

bool CSG_Parameters::Save ( const CSG_String & File ) const

Definition at line 2152 of file parameters.cpp.

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

◆ Save() [2/2]

bool CSG_Parameters::Save ( CSG_MetaData & Data ) const

Definition at line 2130 of file parameters.cpp.

References CSG_MetaData::Destroy(), Get_Count(), CSG_Parameter::Serialize(), CSG_MetaData::Set_Name(), and CSG_MetaData::Set_Property().

Referenced by Save().

◆ Serialize() [1/4]

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

inline

Definition at line 1879 of file parameters.h.

◆ Serialize() [2/4]

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

inline

Definition at line 1878 of file parameters.h.

◆ Serialize() [3/4]

bool CSG_Parameters::Serialize ( CSG_MetaData & Data ) const

inline

Definition at line 1877 of file parameters.h.

◆ Serialize() [4/4]

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

inline

Definition at line 1876 of file parameters.h.

Referenced by CSG_Parameter_Parameters::_Serialize().

◆ Serialize_Compatibility()

bool CSG_Parameters::Serialize_Compatibility ( CSG_File & Stream )

◆ Set_Callback()

bool CSG_Parameters::Set_Callback ( bool bActive = true )

Definition at line 1363 of file parameters.cpp.

References CSG_Parameter::asParameters(), PARAMETER_TYPE_Parameters, and Set_Callback().

Referenced by CSG_Parameter_Grid_System::_Set_Value(), Add_Choice(), Add_Data_Type(), Add_FilePath(), Add_Font(), Restore_Defaults(), Set_Callback(), CSG_Tool::Set_Callback(), CSG_Parameters_Grid_Target::Set_User_Defined(), and CSG_Parameters_Grid_Target::Set_User_Defined_ZLevels().

◆ Set_Callback_On_Parameter_Changed()

TSG_PFNC_Parameter_Changed CSG_Parameters::Set_Callback_On_Parameter_Changed ( TSG_PFNC_Parameter_Changed pCallback )

Definition at line 1342 of file parameters.cpp.

References CSG_Parameter::asParameters(), PARAMETER_TYPE_Parameters, and Set_Callback_On_Parameter_Changed().

Referenced by CSG_Tool::Add_Parameters(), CSG_Tool::CSG_Tool(), and 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 351 of file parameters.cpp.

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

◆ Set_Enabled() [1/2]

void CSG_Parameters::Set_Enabled ( bool bEnabled = true )

Enable or disable all parameters.

Definition at line 405 of file parameters.cpp.

References CSG_Parameter::Set_Enabled().

Referenced by CSG_Grid_Cell_Addressor::Add_Parameters(), CSG_Distance_Weighting::Enable_Parameters(), CSG_Grid_Cell_Addressor::Enable_Parameters(), CSG_Parameters_Point_Search::On_Parameters_Enable(), and CSG_Parameters_Grid_Target::On_Parameters_Enable().

◆ 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 418 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 2081 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()

bool CSG_Parameters::Set_History	(	CSG_MetaData &	History,
		bool	bOptions = `true`,
		bool	bDataObjects = `true`
	)

Definition at line 1967 of file parameters.cpp.

References CSG_MetaData::Add_Child(), CSG_MetaData::Add_Children(), CSG_MetaData::Add_Property(), CSG_Parameter::asDataObject(), CSG_Parameter::asList(), CSG_Parameter::asParameters(), CSG_MetaData::Get_Children_Count(), Get_Count(), CSG_Data_Object::Get_File_Name(), CSG_Data_Object::Get_History(), CSG_Parameter::Get_Identifier(), Get_Identifier(), CSG_Parameter_List::Get_Item(), CSG_Parameter_List::Get_Item_Count(), CSG_Parameter::Get_Name(), CSG_Parameter::Get_Parent(), CSG_Parameter::Get_Type(), CSG_Parameter::Get_Type_Identifier(), CSG_Parameter::is_DataObject(), CSG_Parameter::is_DataObject_List(), CSG_Parameter::is_Enabled(), CSG_Parameter::is_Information(), CSG_Parameter::is_Input(), CSG_Parameter::is_Option(), CSG_Parameter::is_Parameters(), PARAMETER_TYPE_Grid, PARAMETER_TYPE_Grid_List, PARAMETER_TYPE_Grid_System, PARAMETER_TYPE_Grids, PARAMETER_TYPE_Grids_List, PARAMETER_TYPE_String, CSG_Parameter::Serialize(), Set_History(), CSG_MetaData::Set_Name(), and SG_Get_History_Ignore_Lists().

Referenced by CSG_Tool::Dlg_Parameters(), and 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 321 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 223 of file parameters.cpp.

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

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