SAGA API  v9.5
CSG_Parameter_Value Class Reference

#include <parameters.h>

Inheritance diagram for CSG_Parameter_Value:
CSG_Parameter CSG_Parameter_Double CSG_Parameter_Int CSG_Parameter_Degree CSG_Parameter_Color CSG_Parameter_Table_Field

Public Member Functions

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_ParametersGet_Parameters (void) const
 
CSG_ParameterGet_Parent (void) const
 
class CSG_Data_ManagerGet_Manager (void) const
 
virtual TSG_Parameter_Type Get_Type (void) const =0
 
CSG_String Get_Type_Identifier (void) const
 
CSG_String Get_Type_Name (void) const
 
const SG_CharGet_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_CharGet_Name (void) const
 
const SG_CharGet_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_ParameterGet_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_StringGet_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_CharasString (void) const
 
void * asPointer (void) const
 
CSG_ColorsasColors (void) const
 
const SG_CharasFont (void) const
 
CSG_Grid_SystemasGrid_System (void) const
 
CSG_Data_ObjectasDataObject (void) const
 
CSG_GridasGrid (void) const
 
CSG_GridsasGrids (void) const
 
CSG_TableasTable (void) const
 
CSG_ShapesasShapes (void) const
 
CSG_TINasTIN (void) const
 
CSG_PointCloudasPointCloud (void) const
 
class CSG_Parameter_ValueasValue (void) const
 
class CSG_Parameter_DateasDate (void) const
 
class CSG_Parameter_Data_TypeasDataType (void) const
 
class CSG_Parameter_ChoiceasChoice (void) const
 
class CSG_Parameter_ChoicesasChoices (void) const
 
class CSG_Parameter_RangeasRange (void) const
 
class CSG_Parameter_File_NameasFilePath (void) const
 
class CSG_Parameter_Table_FieldsasTableFields (void) const
 
class CSG_ParametersasParameters (void) const
 
class CSG_Parameter_ListasList (void) const
 
class CSG_Parameter_Grid_ListasGridList (void) const
 
class CSG_Parameter_Grids_ListasGridsList (void) const
 
class CSG_Parameter_Table_ListasTableList (void) const
 
class CSG_Parameter_Shapes_ListasShapesList (void) const
 
class CSG_Parameter_TIN_ListasTINList (void) const
 
class CSG_Parameter_PointCloud_ListasPointCloudList (void) const
 
bool Assign (CSG_Parameter *pSource)
 
bool Serialize (CSG_MetaData &MetaData, bool bSave)
 

Protected Member Functions

 CSG_Parameter_Value (CSG_Parameters *pOwner, CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
 
virtual bool _Assign (CSG_Parameter *pSource)
 
- 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 int _Set_Value (void *Value)
 
virtual void _Set_String (void)
 
virtual int _asInt (void) const
 
virtual double _asDouble (void) const
 
virtual void * _asPointer (void) const
 
virtual const SG_Char_asString (void) const
 
virtual bool _Serialize (CSG_MetaData &MetaData, bool bSave)
 

Protected Attributes

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

Constructor & Destructor Documentation

◆ CSG_Parameter_Value()

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

Definition at line 328 of file parameter_data.cpp.

References m_bMaximum, m_bMinimum, m_Maximum, and m_Minimum.

Member Function Documentation

◆ _Assign()

bool CSG_Parameter_Value::_Assign ( CSG_Parameter pSource)
protectedvirtual

◆ Get_Maximum()

double CSG_Parameter_Value::Get_Maximum ( void  ) const
inline

Definition at line 445 of file parameters.h.

Referenced by SG_XML_Add_Parameter().

◆ Get_Minimum()

double CSG_Parameter_Value::Get_Minimum ( void  ) const
inline

Definition at line 441 of file parameters.h.

Referenced by SG_XML_Add_Parameter().

◆ has_Maximum()

bool CSG_Parameter_Value::has_Maximum ( void  ) const
inline

Definition at line 446 of file parameters.h.

Referenced by SG_XML_Add_Parameter().

◆ has_Minimum()

bool CSG_Parameter_Value::has_Minimum ( void  ) const
inline

Definition at line 442 of file parameters.h.

Referenced by SG_XML_Add_Parameter().

◆ Set_Maximum()

void CSG_Parameter_Value::Set_Maximum ( double  Maximum,
bool  bOn = true 
)

Definition at line 391 of file parameter_data.cpp.

References m_bMaximum, m_bMinimum, m_Minimum, and Set_Valid_Range().

◆ Set_Minimum()

void CSG_Parameter_Value::Set_Minimum ( double  Minimum,
bool  bOn = true 
)

Definition at line 371 of file parameter_data.cpp.

References m_bMaximum, m_bMinimum, m_Maximum, and Set_Valid_Range().

◆ Set_Valid_Range()

Friends And Related Function Documentation

◆ CSG_Parameters

friend class CSG_Parameters
friend

Definition at line 461 of file parameters.h.

Member Data Documentation

◆ m_bMaximum

bool CSG_Parameter_Value::m_bMaximum
protected

◆ m_bMinimum

bool CSG_Parameter_Value::m_bMinimum
protected

◆ m_Maximum

double CSG_Parameter_Value::m_Maximum
protected

◆ m_Minimum

double CSG_Parameter_Value::m_Minimum
protected

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