SAGA API  v9.5
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
CSG_Parameter_Grid_List Class Reference

#include <parameters.h>

Inheritance diagram for CSG_Parameter_Grid_List:
CSG_Parameter_List CSG_Parameter

Public Member Functions

virtual TSG_Parameter_Type Get_Type (void) const
 
CSG_Grid_System * Get_System (void) const
 
virtual bool Add_Item (CSG_Data_Object *pItem)
 
virtual bool Del_Item (CSG_Data_Object *pItem, bool bUpdateData=true)
 
virtual bool Del_Item (int Index, bool bUpdateData=true)
 
virtual bool Del_Items (void)
 
virtual bool Update_Data (void)
 
int Get_Grid_Count (void) const
 
CSG_Grid * Get_Grid (int Index) const
 
- Public Member Functions inherited from CSG_Parameter_List
int Get_Item_Count (void) const
 
CSG_Data_Object * Get_Item (int Index) 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
 
virtual bool is_Valid (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 bDoUse=false)
 
void Set_UseInCMD (bool bDoUse=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 (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_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_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_List (CSG_Parameters *pOwner, CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
 
- Protected Member Functions inherited from CSG_Parameter_List
 CSG_Parameter_List (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 void _Set_String (void)
 
virtual int _asInt (void) const
 
virtual void * _asPointer (void) const
 
virtual bool _Assign (CSG_Parameter *pSource)
 
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 (const CSG_String &Value)
 
virtual double _asDouble (void) const
 
virtual const SG_Char * _asString (void) const
 

Protected Attributes

CSG_Array_Pointer m_Grids
 
- Protected Attributes inherited from CSG_Parameter
CSG_String m_String
 

Friends

class CSG_Parameters
 

Detailed Description

Definition at line 1408 of file parameters.h.

Constructor & Destructor Documentation

◆ CSG_Parameter_Grid_List()

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

Definition at line 3196 of file parameter_data.cpp.

Member Function Documentation

◆ Add_Item()

bool CSG_Parameter_Grid_List::Add_Item ( CSG_Data_Object *  pItem)
virtual

Reimplemented from CSG_Parameter_List.

Definition at line 3214 of file parameter_data.cpp.

References CSG_Parameter_List::Add_Item(), 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_Data_Object::Get_ObjectType(), CSG_Parameter::Get_Parent(), Get_System(), CSG_Parameter_Grids_List::Get_System(), CSG_Parameter::Get_Type(), CSG_Parameter::is_DataObject_List(), CSG_Parameter::is_Input(), CSG_Grid_System::is_Valid(), PARAMETER_TYPE_Grid, PARAMETER_TYPE_Grid_List, PARAMETER_TYPE_Grids, PARAMETER_TYPE_Grids_List, CSG_Parameter::Set_Value(), SG_DATAOBJECT_TYPE_Grid, SG_DATAOBJECT_TYPE_Grids, and Update_Data().

◆ Del_Item() [1/2]

bool CSG_Parameter_Grid_List::Del_Item ( CSG_Data_Object *  pItem,
bool  bUpdateData = true 
)
virtual

Reimplemented from CSG_Parameter_List.

Definition at line 3273 of file parameter_data.cpp.

References CSG_Parameter_List::Del_Item().

◆ Del_Item() [2/2]

bool CSG_Parameter_Grid_List::Del_Item ( int  Index,
bool  bUpdateData = true 
)
virtual

Reimplemented from CSG_Parameter_List.

Definition at line 3279 of file parameter_data.cpp.

References CSG_Parameter_List::Del_Item().

◆ Del_Items()

bool CSG_Parameter_Grid_List::Del_Items ( void  )
virtual

Reimplemented from CSG_Parameter_List.

Definition at line 3285 of file parameter_data.cpp.

References CSG_Parameter_List::Del_Items(), and Update_Data().

◆ Get_Grid()

CSG_Grid* CSG_Parameter_Grid_List::Get_Grid ( int  Index) const
inline

Definition at line 1424 of file parameters.h.

◆ Get_Grid_Count()

int CSG_Parameter_Grid_List::Get_Grid_Count ( void  ) const
inline

Definition at line 1423 of file parameters.h.

◆ Get_System()

CSG_Grid_System * CSG_Parameter_Grid_List::Get_System ( void  ) const

Definition at line 3203 of file parameter_data.cpp.

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

Referenced by CSG_Parameter_Grid::_Set_Value(), and Add_Item().

◆ Get_Type()

virtual TSG_Parameter_Type CSG_Parameter_Grid_List::Get_Type ( void  ) const
inlinevirtual

Implements CSG_Parameter.

Definition at line 1412 of file parameters.h.

References PARAMETER_TYPE_Grid_List.

Referenced by Get_System().

◆ Update_Data()

bool CSG_Parameter_Grid_List::Update_Data ( void  )
virtual

Reimplemented from CSG_Parameter_List.

Definition at line 3291 of file parameter_data.cpp.

References CSG_Array_Pointer::Add(), CSG_Parameter::asGrid_System(), CSG_Grid_System::Destroy(), CSG_Parameter::Get_Children_Count(), CSG_Grids::Get_Grid_Count(), CSG_Grids::Get_Grid_Ptr(), CSG_Parameter_List::Get_Item(), CSG_Parameter_List::Get_Item_Count(), CSG_Data_Object::Get_ObjectType(), CSG_Parameter::Get_Parameters(), CSG_Parameter::Get_Parent(), CSG_Array_Pointer::Get_Size(), CSG_Parameter::Get_Type(), CSG_Parameters::has_GUI(), m_Grids, PARAMETER_TYPE_Grid_System, CSG_Array_Pointer::Set_Array(), SG_DATAOBJECT_TYPE_Grid, and SG_DATAOBJECT_TYPE_Grids.

Referenced by Add_Item(), and Del_Items().

Friends And Related Function Documentation

◆ CSG_Parameters

friend class CSG_Parameters
friend

Definition at line 1434 of file parameters.h.

Member Data Documentation

◆ m_Grids

CSG_Array_Pointer CSG_Parameter_Grid_List::m_Grids
protected

Definition at line 1431 of file parameters.h.

Referenced by Update_Data().

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