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

#include <parameters.h>

Inheritance diagram for CSG_Parameter_Choice:
CSG_Parameter CSG_Parameter_Data_Type

Public Member Functions

virtual TSG_Parameter_Type Get_Type (void) const
 
virtual bool is_Default (void) const
 
virtual bool Toggle_Value (void)
 
bool Del_Items (void)
 
bool Add_Item (const CSG_String &Item, const CSG_String &Data="")
 
bool Set_Items (const SG_Char *String)
 
CSG_String Get_Items (void) const
 
const SG_Char * Get_Item (int Index) const
 
CSG_String Get_Item_Data (int Index) const
 
CSG_String Get_Data (void) const
 
bool Get_Data (CSG_String &Value) const
 
bool Get_Data (int &Value) const
 
bool Get_Data (double &Value) const
 
int Get_Count (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
 
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)
 
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 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_Choice (CSG_Parameters *pOwner, CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
 
virtual int _Set_Value (int Value)
 
virtual int _Set_Value (double Value)
 
virtual int _Set_Value (const CSG_String &Value)
 
virtual void _Set_String (void)
 
virtual int _asInt (void) const
 
virtual double _asDouble (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 (void *Value)
 
virtual void * _asPointer (void) const
 
virtual const SG_Char * _asString (void) const
 

Protected Attributes

int m_Value
 
CSG_Strings m_Items
 
CSG_Strings m_Data
 
- Protected Attributes inherited from CSG_Parameter
CSG_String m_String
 

Friends

class CSG_Parameters
 

Detailed Description

Definition at line 659 of file parameters.h.

Constructor & Destructor Documentation

◆ CSG_Parameter_Choice()

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

Definition at line 891 of file parameter_data.cpp.

References m_Value.

Member Function Documentation

◆ _asDouble()

virtual double CSG_Parameter_Choice::_asDouble ( void  ) const
inlineprotectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 702 of file parameters.h.

◆ _asInt()

virtual int CSG_Parameter_Choice::_asInt ( void  ) const
inlineprotectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 701 of file parameters.h.

◆ _Assign()

bool CSG_Parameter_Choice::_Assign ( CSG_Parameter *  pSource)
protectedvirtual

Reimplemented from CSG_Parameter.

Reimplemented in CSG_Parameter_Data_Type.

Definition at line 1095 of file parameter_data.cpp.

References _Set_String(), CSG_Parameter::asChoice(), m_Data, m_Items, and m_Value.

Referenced by CSG_Parameter_Data_Type::_Assign().

◆ _Serialize()

bool CSG_Parameter_Choice::_Serialize ( CSG_MetaData &  Entry,
bool  bSave 
)
protectedvirtual

Reimplemented from CSG_Parameter.

Reimplemented in CSG_Parameter_Data_Type.

Definition at line 1107 of file parameter_data.cpp.

References _Set_Value(), CSG_MetaData::Add_Property(), CSG_String::asInt(), CSG_Parameter::asString(), CSG_MetaData::Get_Content(), CSG_MetaData::Get_Property(), m_Value, and CSG_MetaData::Set_Content().

Referenced by CSG_Parameter_Data_Type::_Serialize().

◆ _Set_String()

void CSG_Parameter_Choice::_Set_String ( void  )
protectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 1089 of file parameter_data.cpp.

References _TL, Get_Count(), Get_Item(), CSG_Parameter::m_String, and m_Value.

Referenced by _Assign(), Add_Item(), and Set_Items().

◆ _Set_Value() [1/3]

int CSG_Parameter_Choice::_Set_Value ( const CSG_String &  Value)
protectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 1064 of file parameter_data.cpp.

References _Set_Value(), CSG_String::asInt(), CSG_String::Cmp(), CSG_Strings::Get_Count(), Get_Item(), Get_Item_Data(), CSG_String::is_Empty(), m_Items, and SG_PARAMETER_DATA_SET_FALSE.

◆ _Set_Value() [2/3]

int CSG_Parameter_Choice::_Set_Value ( double  Value)
protectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 1058 of file parameter_data.cpp.

References _Set_Value().

◆ _Set_Value() [3/3]

int CSG_Parameter_Choice::_Set_Value ( int  Value)
protectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 1040 of file parameter_data.cpp.

References CSG_Strings::Get_Count(), m_Items, m_Value, SG_PARAMETER_DATA_SET_CHANGED, SG_PARAMETER_DATA_SET_FALSE, and SG_PARAMETER_DATA_SET_TRUE.

Referenced by _Serialize(), and _Set_Value().

◆ Add_Item()

bool CSG_Parameter_Choice::Add_Item ( const CSG_String &  Item,
const CSG_String &  Data = "" 
)

Definition at line 918 of file parameter_data.cpp.

References _Set_String(), CSG_Strings::Add(), CSG_String::is_Empty(), m_Data, and m_Items.

Referenced by CSG_Parameter_Data_Type::Set_Data_Types(), and Set_Items().

◆ Del_Items()

bool CSG_Parameter_Choice::Del_Items ( void  )

Definition at line 910 of file parameter_data.cpp.

References CSG_Strings::Clear(), m_Data, and m_Items.

◆ Get_Count()

int CSG_Parameter_Choice::Get_Count ( void  ) const
inline

Definition at line 683 of file parameters.h.

Referenced by _Set_String(), CSG_Parameter::Get_Description(), Get_Item(), Get_Item_Data(), Get_Items(), CSG_Parameter::is_Compatible(), CSG_Parameter_Data_Type::Set_Data_Type(), CSG_Parameter_Data_Type::Set_Data_Types(), Set_Items(), and Toggle_Value().

◆ Get_Data() [1/4]

bool CSG_Parameter_Choice::Get_Data ( CSG_String &  Value) const

Definition at line 1018 of file parameter_data.cpp.

References Get_Item_Data(), CSG_String::is_Empty(), and m_Value.

◆ Get_Data() [2/4]

bool CSG_Parameter_Choice::Get_Data ( double &  Value) const

Definition at line 1032 of file parameter_data.cpp.

References CSG_String::asDouble(), and Get_Data().

◆ Get_Data() [3/4]

bool CSG_Parameter_Choice::Get_Data ( int &  Value) const

Definition at line 1025 of file parameter_data.cpp.

References CSG_String::asInt(), and Get_Data().

◆ Get_Data() [4/4]

CSG_String CSG_Parameter_Choice::Get_Data ( void  ) const

Definition at line 1013 of file parameter_data.cpp.

References Get_Item_Data(), and m_Value.

Referenced by Get_Data(), and CSG_Parameter_Data_Type::Get_Data_Type().

◆ Get_Item()

const SG_Char * CSG_Parameter_Choice::Get_Item ( int  Index) const

Definition at line 992 of file parameter_data.cpp.

References Get_Count(), and m_Items.

Referenced by _Set_String(), _Set_Value(), CSG_Parameter::is_Compatible(), and SG_XML_Add_Parameter().

◆ Get_Item_Data()

CSG_String CSG_Parameter_Choice::Get_Item_Data ( int  Index) const

Definition at line 1003 of file parameter_data.cpp.

References Get_Count(), and m_Data.

Referenced by _Set_Value(), Get_Data(), and CSG_Parameter_Data_Type::Set_Data_Type().

◆ Get_Items()

CSG_String CSG_Parameter_Choice::Get_Items ( void  ) const

Definition at line 974 of file parameter_data.cpp.

References Get_Count(), and m_Items.

◆ Get_Type()

virtual TSG_Parameter_Type CSG_Parameter_Choice::Get_Type ( void  ) const
inlinevirtual

Implements CSG_Parameter.

Reimplemented in CSG_Parameter_Data_Type.

Definition at line 663 of file parameters.h.

References PARAMETER_TYPE_Choice.

◆ is_Default()

bool CSG_Parameter_Choice::is_Default ( void  ) const
virtual

Reimplemented from CSG_Parameter.

Definition at line 898 of file parameter_data.cpp.

References CSG_Parameter::asInt(), CSG_Parameter::Get_Default(), and m_Value.

◆ Set_Items()

bool CSG_Parameter_Choice::Set_Items ( const SG_Char *  String)

Definition at line 934 of file parameter_data.cpp.

References _Set_String(), Add_Item(), CSG_Strings::Clear(), CSG_Strings::Get_Count(), Get_Count(), m_Data, m_Items, m_Value, SG_String_Tokenize(), and CSG_String::Trim().

Referenced by CSG_Parameters::Add_Choice().

◆ Toggle_Value()

bool CSG_Parameter_Choice::Toggle_Value ( void  )
virtual

Reimplemented from CSG_Parameter.

Definition at line 904 of file parameter_data.cpp.

References CSG_Parameter::asInt(), Get_Count(), and CSG_Parameter::Set_Value().

Friends And Related Function Documentation

◆ CSG_Parameters

friend class CSG_Parameters
friend

Definition at line 708 of file parameters.h.

Member Data Documentation

◆ m_Data

CSG_Strings CSG_Parameter_Choice::m_Data
protected

Definition at line 692 of file parameters.h.

Referenced by _Assign(), Add_Item(), Del_Items(), Get_Item_Data(), and Set_Items().

◆ m_Items

CSG_Strings CSG_Parameter_Choice::m_Items
protected

Definition at line 692 of file parameters.h.

Referenced by _Assign(), _Set_Value(), Add_Item(), Del_Items(), Get_Item(), Get_Items(), and Set_Items().

◆ m_Value

int CSG_Parameter_Choice::m_Value
protected

Definition at line 690 of file parameters.h.

Referenced by _Assign(), _Serialize(), _Set_String(), _Set_Value(), CSG_Parameter_Choice(), Get_Data(), is_Default(), and Set_Items().

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