SAGA API  v9.6
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
CSG_Parameter_Table_Field Class Reference

#include <parameters.h>

Inheritance diagram for CSG_Parameter_Table_Field:
CSG_Parameter_Int CSG_Parameter_Value CSG_Parameter

Public Member Functions

virtual TSG_Parameter_Type Get_Type (void) const
 
bool Add_Default (double Value, double Minimum, bool bMinimum, double Maximum, bool bMaximum)
 
CSG_Table * Get_Table (void) const
 
- Public Member Functions inherited from CSG_Parameter_Int
virtual bool is_Default (void) const
 
- Public Member Functions inherited from CSG_Parameter_Value
bool Set_Valid_Range (double Minimum, double Maximum)
 
void Set_Minimum (double Minimum, bool bOn=true)
 
double Get_Minimum (void) const
 
bool has_Minimum (void) const
 
void Set_Maximum (double Maximum, bool bOn=true)
 
double Get_Maximum (void) const
 
bool has_Maximum (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)
 
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 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)
 

Static Public Member Functions

static CSG_String Get_Choices (const class CSG_Table &Table, bool bAllowNone=false)
 

Protected Member Functions

 CSG_Parameter_Table_Field (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 (const CSG_String &Value)
 
virtual void _Set_String (void)
 
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_Int
 CSG_Parameter_Int (CSG_Parameters *pOwner, CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
 
virtual int _Set_Value (double Value)
 
virtual int _asInt (void) const
 
- Protected Member Functions inherited from CSG_Parameter_Value
 CSG_Parameter_Value (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
 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_Default
 
- Protected Attributes inherited from CSG_Parameter_Int
int m_Value
 
- Protected Attributes inherited from CSG_Parameter_Value
bool m_bMinimum
 
bool m_bMaximum
 
double m_Minimum
 
double m_Maximum
 
- Protected Attributes inherited from CSG_Parameter
CSG_String m_String
 

Friends

class CSG_Parameters
 

Detailed Description

Definition at line 1056 of file parameters.h.

Constructor & Destructor Documentation

◆ CSG_Parameter_Table_Field()

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

Definition at line 2156 of file parameter_data.cpp.

References m_Default, and CSG_Parameter_Int::m_Value.

Member Function Documentation

◆ _asDouble()

double CSG_Parameter_Table_Field::_asDouble ( void  ) const
protectedvirtual

Reimplemented from CSG_Parameter_Int.

Definition at line 2265 of file parameter_data.cpp.

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

◆ _Assign()

bool CSG_Parameter_Table_Field::_Assign ( CSG_Parameter *  pSource)
protectedvirtual

Reimplemented from CSG_Parameter_Int.

Definition at line 2271 of file parameter_data.cpp.

References _Set_String(), m_Default, and CSG_Parameter_Int::m_Value.

◆ _Serialize()

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

Reimplemented from CSG_Parameter_Int.

Definition at line 2282 of file parameter_data.cpp.

References _Set_Value(), CSG_Parameter::asInt(), CSG_Parameter::asString(), CSG_MetaData::Get_Content(), CSG_MetaData::Get_Property(), CSG_MetaData::Set_Content(), and CSG_MetaData::Set_Property().

◆ _Set_String()

void CSG_Parameter_Table_Field::_Set_String ( void  )
protectedvirtual

Reimplemented from CSG_Parameter_Int.

Definition at line 2246 of file parameter_data.cpp.

References _TL, CSG_Table::Get_Field_Count(), CSG_Table::Get_Field_Name(), Get_Table(), CSG_Parameter::m_String, and CSG_Parameter_Int::m_Value.

Referenced by _Assign().

◆ _Set_Value() [1/2]

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

Reimplemented from CSG_Parameter_Int.

Definition at line 2220 of file parameter_data.cpp.

References _Set_Value(), CSG_String::asInt(), CSG_String::CmpNoCase(), CSG_Table::Get_Field_Count(), CSG_Table::Get_Field_Name(), and Get_Table().

◆ _Set_Value() [2/2]

int CSG_Parameter_Table_Field::_Set_Value ( int  Value)
protectedvirtual

Reimplemented from CSG_Parameter_Int.

Definition at line 2188 of file parameter_data.cpp.

References CSG_Parameter::Get_Child(), CSG_Table::Get_Field_Count(), Get_Table(), CSG_Parameter::is_Optional(), m_Default, CSG_Parameter_Int::m_Value, CSG_Parameter::Set_Enabled(), SG_PARAMETER_DATA_SET_CHANGED, and SG_PARAMETER_DATA_SET_TRUE.

Referenced by _Serialize(), and _Set_Value().

◆ Add_Default()

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

Definition at line 2164 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_Optional(), and m_Default.

◆ Get_Choices()

CSG_String CSG_Parameter_Table_Field::Get_Choices ( const class CSG_Table &  Table,
bool  bAllowNone = false 
)
static

Definition at line 2305 of file parameter_data.cpp.

References _TL, CSG_Table::Get_Field_Count(), and CSG_Table::Get_Field_Name().

◆ Get_Table()

CSG_Table * CSG_Parameter_Table_Field::Get_Table ( void  ) const

Definition at line 2180 of file parameter_data.cpp.

References CSG_Parameter::asTable(), DATAOBJECT_CREATE, CSG_Table::Get_Field_Count(), and CSG_Parameter::Get_Parent().

Referenced by _Set_String(), and _Set_Value().

◆ Get_Type()

virtual TSG_Parameter_Type CSG_Parameter_Table_Field::Get_Type ( void  ) const
inlinevirtual

Reimplemented from CSG_Parameter_Int.

Definition at line 1060 of file parameters.h.

References PARAMETER_TYPE_Table_Field.

Friends And Related Function Documentation

◆ CSG_Parameters

friend class CSG_Parameters
friend

Definition at line 1087 of file parameters.h.

Member Data Documentation

◆ m_Default

int CSG_Parameter_Table_Field::m_Default
protected

Definition at line 1073 of file parameters.h.

Referenced by _asDouble(), _Assign(), _Set_Value(), Add_Default(), and CSG_Parameter_Table_Field().

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