SAGA API Version 9.14
Loading...
Searching...
No Matches
CSG_Parameter_Grid Class Reference

#include <parameters.h>

Inheritance diagram for CSG_Parameter_Grid:
CSG_Parameter_Data_Object CSG_Parameter CSG_Parameter_Grids

Public Member Functions

virtual TSG_Parameter_Type Get_Type (void) const
void Set_Preferred_Type (TSG_Data_Type Type)
TSG_Data_Type Get_Preferred_Type (void) const
CSG_Grid_System * Get_System (void) const
bool Add_Default (double Value, double Minimum, bool bMinimum, double Maximum, bool bMaximum)
Public Member Functions inherited from CSG_Parameter_Data_Object
virtual bool is_Valid (void) const
Public Member Functions inherited from CSG_Parameter
CSG_Parameters * Get_Parameters (void) const
CSG_Parameter * Get_Parent (void) const
class CSG_Data_Manager * Get_Manager (void) const
CSG_String Get_Type_Identifier (void) const
CSG_String Get_Type_Name (void) const
const SG_Char * Get_Identifier (void) const
bool Cmp_Identifier (const CSG_String &Identifier) const
CSG_String Get_CmdID (void) const
bool Set_Name (const CSG_String &Name)
const SG_Char * Get_Name (void) const
const SG_Char * Get_Description (void) const
bool Set_Description (const CSG_String &Description)
CSG_String Get_Description (int Flags) const
CSG_String Get_Description (int Flags, const SG_Char *Separator) const
bool Set_Enabled (bool bEnabled=true)
bool is_Enabled (bool bCheckEnv=true) const
bool Set_Collapsed (bool bOn=true)
bool is_Collapsed (void) const
bool is_Input (void) const
bool is_Output (void) const
bool is_Optional (void) const
bool is_Information (void) const
bool is_Option (void) const
bool is_DataObject (void) const
bool is_DataObject_List (void) const
bool is_Parameters (void) const
bool is_Serializable (void) const
bool is_Compatible (CSG_Parameter *pParameter) const
bool is_Value_Equal (CSG_Parameter *pParameter) const
void Set_UseInGUI (bool bOn=false)
void Set_UseInCMD (bool bOn=false)
bool do_UseInGUI (void) const
bool do_UseInCMD (void) const
void ignore_Projection (bool bIgnore)
bool ignore_Projection (void) const
TSG_Data_Object_Type Get_DataObject_Type (void) const
int Get_Children_Count (void) const
CSG_Parameter * Get_Child (int iChild) const
bool Set_Children_Enabled (bool bEnabled=true)
virtual bool Set_Value (int Value)
virtual bool Set_Value (double Value)
virtual bool Set_Value (CSG_Grid_Resampling Value)
virtual bool Set_Value (const CSG_String &Value)
virtual bool Set_Value (const char *Value)
virtual bool Set_Value (const wchar_t *Value)
virtual bool Set_Value (void *Value)
virtual bool Set_Value (CSG_Parameter *Value)
virtual bool Toggle_Value (void)
bool Set_Default (int Value)
bool Set_Default (double Value)
bool Set_Default (const CSG_String &Value)
const CSG_String & Get_Default (void) const
virtual bool is_Default (void) const
virtual bool Restore_Default (void)
bool Check (bool bSilent=true)
bool has_Changed (int Check_Flags=PARAMETER_CHECK_ALL)
bool asBool (void) const
int asInt (void) const
long asColor (void) const
double asDouble (void) const
const SG_Char * asString (void) const
void * asPointer (void) const
CSG_Colors * asColors (void) const
const SG_Char * asFont (void) const
CSG_Grid_System * asGrid_System (void) const
CSG_Grid_Resampling asGrid_Resampling (void) const
CSG_Data_Object * asDataObject (void) const
CSG_Grid * asGrid (void) const
CSG_Grids * asGrids (void) const
CSG_Table * asTable (void) const
CSG_Shapes * asShapes (void) const
CSG_TIN * asTIN (void) const
CSG_PointCloud * asPointCloud (void) const
class CSG_Parameter_Value * asValue (void) const
class CSG_Parameter_Date * asDate (void) const
class CSG_Parameter_Data_Type * asDataType (void) const
class CSG_Parameter_Choice * asChoice (void) const
class CSG_Parameter_Choices * asChoices (void) const
class CSG_Parameter_Range * asRange (void) const
class CSG_Parameter_File_Name * asFilePath (void) const
class CSG_Parameter_Table_Field * asTableField (void) const
class CSG_Parameter_Table_Fields * asTableFields (void) const
class CSG_Parameters * asParameters (void) const
class CSG_Parameter_List * asList (void) const
class CSG_Parameter_Grid_List * asGridList (void) const
class CSG_Parameter_Grids_List * asGridsList (void) const
class CSG_Parameter_Table_List * asTableList (void) const
class CSG_Parameter_Shapes_List * asShapesList (void) const
class CSG_Parameter_TIN_List * asTINList (void) const
class CSG_Parameter_PointCloud_List * asPointCloudList (void) const
bool Assign (CSG_Parameter *pSource)
bool Serialize (CSG_MetaData &MetaData, bool bSave)

Protected Member Functions

 CSG_Parameter_Grid (CSG_Parameters *pOwner, CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
virtual int _Set_Value (void *Value)
virtual int _asInt (void) const
virtual double _asDouble (void) const
virtual bool _Assign (CSG_Parameter *pSource)
Protected Member Functions inherited from CSG_Parameter_Data_Object
 CSG_Parameter_Data_Object (CSG_Parameters *pOwner, CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
virtual void _Set_String (void)
virtual void * _asPointer (void) const
virtual bool _Serialize (CSG_MetaData &Entry, bool bSave)
Protected Member Functions inherited from CSG_Parameter
 CSG_Parameter (CSG_Parameters *pOwner, CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
virtual ~CSG_Parameter (void)
virtual int _Set_Value (int Value)
virtual int _Set_Value (double Value)
virtual int _Set_Value (CSG_Grid_Resampling Value)
virtual int _Set_Value (const CSG_String &Value)
virtual const SG_Char * _asString (void) const

Protected Attributes

int m_Default
TSG_Data_Type m_Type
Protected Attributes inherited from CSG_Parameter_Data_Object
CSG_Data_Object * m_pDataObject
Protected Attributes inherited from CSG_Parameter
CSG_String m_String

Friends

class CSG_Parameters

Detailed Description

Definition at line 1211 of file parameters.h.

Constructor & Destructor Documentation

◆ CSG_Parameter_Grid()

CSG_Parameter_Grid::CSG_Parameter_Grid ( CSG_Parameters * pOwner,
CSG_Parameter * pParent,
const CSG_String & ID,
const CSG_String & Name,
const CSG_String & Description,
int Constraint )
protected

Definition at line 2771 of file parameter_data.cpp.

References CSG_Parameter_Data_Object::CSG_Parameter_Data_Object(), CSG_Parameters, m_Default, m_Type, and SG_DATATYPE_Undefined.

Referenced by _Assign(), and CSG_Parameter_Grids::CSG_Parameter_Grids().

Member Function Documentation

◆ _asDouble()

double CSG_Parameter_Grid::_asDouble ( void ) const
protectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 2885 of file parameter_data.cpp.

References CSG_Parameter::asDouble(), CSG_Parameter::Get_Child(), and m_Default.

◆ _asInt()

int CSG_Parameter_Grid::_asInt ( void ) const
protectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 2879 of file parameter_data.cpp.

References CSG_Parameter::asInt(), CSG_Parameter::Get_Child(), and m_Default.

◆ _Assign()

bool CSG_Parameter_Grid::_Assign ( CSG_Parameter * pSource)
protectedvirtual

Reimplemented from CSG_Parameter_Data_Object.

Definition at line 2891 of file parameter_data.cpp.

References _Set_Value(), CSG_Parameter::asPointer(), CSG_Parameter_Grid(), m_Default, and m_Type.

◆ _Set_Value()

int CSG_Parameter_Grid::_Set_Value ( void * Value)
protectedvirtual

Reimplemented from CSG_Parameter_Data_Object.

Definition at line 2806 of file parameter_data.cpp.

References CSG_Parameter::asDataObject(), CSG_Parameter::asGridList(), CSG_Parameter::asGridsList(), CSG_Parameter::asList(), DATAOBJECT_CREATE, DATAOBJECT_NOTSET, CSG_Parameter::Get_Child(), CSG_Parameter::Get_Children_Count(), CSG_Parameter_List::Get_Item_Count(), CSG_Parameter::Get_Parameters(), CSG_Parameter::Get_Parent(), Get_System(), CSG_Parameter_Grid_List::Get_System(), CSG_Parameter_Grids_List::Get_System(), CSG_Parameter::Get_Type(), Get_Type(), CSG_Parameter::is_DataObject_List(), CSG_Parameter::is_Input(), CSG_Parameter::is_Output(), CSG_Grid_System::is_Valid(), CSG_Parameter_Data_Object::is_Valid(), m_Default, CSG_Parameter_Data_Object::m_pDataObject, PARAMETER_TYPE_Grid, PARAMETER_TYPE_Grid_List, PARAMETER_TYPE_Grids, PARAMETER_TYPE_Grids_List, CSG_Parameter::Set_Enabled(), CSG_Parameter::Set_Value(), SG_PARAMETER_DATA_SET_CHANGED, SG_PARAMETER_DATA_SET_FALSE, and SG_PARAMETER_DATA_SET_TRUE.

Referenced by _Assign().

◆ Add_Default()

bool CSG_Parameter_Grid::Add_Default ( double Value,
double Minimum,
bool bMinimum,
double Maximum,
bool bMaximum )

Definition at line 2790 of file parameter_data.cpp.

References _TL, CSG_Parameters::Add_Double(), CSG_String::Format(), CSG_Parameter::Get_Children_Count(), CSG_Parameter::Get_Identifier(), CSG_Parameter::Get_Parameters(), CSG_Parameter::is_Input(), CSG_Parameter::is_Optional(), m_Default, Maximum, and Minimum.

◆ Get_Preferred_Type()

TSG_Data_Type CSG_Parameter_Grid::Get_Preferred_Type ( void ) const
inline

Definition at line 1218 of file parameters.h.

References m_Type.

◆ Get_System()

CSG_Grid_System * CSG_Parameter_Grid::Get_System ( void ) const

Definition at line 2784 of file parameter_data.cpp.

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

Referenced by _Set_Value().

◆ Get_Type()

virtual TSG_Parameter_Type CSG_Parameter_Grid::Get_Type ( void ) const
inlinevirtual

Implements CSG_Parameter.

Reimplemented in CSG_Parameter_Grids.

Definition at line 1215 of file parameters.h.

References PARAMETER_TYPE_Grid.

Referenced by _Set_Value().

◆ Set_Preferred_Type()

void CSG_Parameter_Grid::Set_Preferred_Type ( TSG_Data_Type Type)

Definition at line 2778 of file parameter_data.cpp.

References m_Type.

◆ CSG_Parameters

friend class CSG_Parameters
friend

Definition at line 1242 of file parameters.h.

References CSG_Parameters.

Referenced by CSG_Parameter_Grid(), and CSG_Parameters.

Member Data Documentation

◆ m_Default

int CSG_Parameter_Grid::m_Default
protected

Definition at line 1229 of file parameters.h.

Referenced by _asDouble(), _asInt(), _Assign(), _Set_Value(), Add_Default(), and CSG_Parameter_Grid().

◆ m_Type

TSG_Data_Type CSG_Parameter_Grid::m_Type
protected

Definition at line 1231 of file parameters.h.

Referenced by _Assign(), CSG_Parameter_Grid(), Get_Preferred_Type(), and Set_Preferred_Type().

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