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

#include <parameters.h>

Inheritance diagram for CSG_Parameter_Range:
CSG_Parameter

Public Member Functions

virtual TSG_Parameter_Type Get_Type (void) const
 
bool Set_Range (double Min, double Max)
 
double Get_Range (void) const
 
bool Set_Min (double Min)
 
double Get_Min (void) const
 
CSG_Parameter_Double * Get_Min_Parameter (void) const
 
bool Set_Max (double Max)
 
double Get_Max (void) const
 
CSG_Parameter_Double * Get_Max_Parameter (void) const
 
virtual bool is_Default (void) const
 
virtual bool Restore_Default (void)
 
- 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
 
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_Range (CSG_Parameters *pOwner, CSG_Parameter *pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)
 
virtual ~CSG_Parameter_Range (void)
 
virtual int _Set_Value (const CSG_String &Value)
 
virtual void _Set_String (void)
 
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 (void *Value)
 
virtual int _asInt (void) const
 
virtual double _asDouble (void) const
 
virtual void * _asPointer (void) const
 
virtual const SG_Char * _asString (void) const
 

Protected Attributes

CSG_Parameters * m_pRange
 
CSG_Parameter_Double * m_pMin
 
CSG_Parameter_Double * m_pMax
 
- Protected Attributes inherited from CSG_Parameter
CSG_String m_String
 

Friends

class CSG_Parameters
 

Detailed Description

Definition at line 610 of file parameters.h.

Constructor & Destructor Documentation

◆ CSG_Parameter_Range()

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

Definition at line 746 of file parameter_data.cpp.

References CSG_Parameters::Add_Double(), CSG_Parameters::Add_Info_Value(), CSG_Parameters, CSG_Parameter::is_Information(), m_pMax, m_pMin, m_pRange, and PARAMETER_TYPE_Double.

◆ ~CSG_Parameter_Range()

CSG_Parameter_Range::~CSG_Parameter_Range ( void  )
protectedvirtual

Definition at line 763 of file parameter_data.cpp.

References m_pRange.

Member Function Documentation

◆ _Assign()

bool CSG_Parameter_Range::_Assign ( CSG_Parameter *  pSource)
protectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 850 of file parameter_data.cpp.

References CSG_Parameter::asRange(), CSG_Parameter::Assign(), m_pMax, and m_pMin.

◆ _Serialize()

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

Reimplemented from CSG_Parameter.

Definition at line 859 of file parameter_data.cpp.

References CSG_String::AfterFirst(), CSG_String::asDouble(), CSG_String::BeforeFirst(), CSG_MetaData::Fmt_Content(), CSG_MetaData::Get_Content(), Get_Max(), Get_Min(), Set_Range(), and SG_Get_Significant_Decimals().

◆ _Set_String()

void CSG_Parameter_Range::_Set_String ( void  )
protectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 769 of file parameter_data.cpp.

References Get_Max(), Get_Min(), CSG_Parameter::m_String, CSG_String::Printf(), and SG_Get_Significant_Decimals().

◆ _Set_Value()

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

Reimplemented from CSG_Parameter.

Definition at line 778 of file parameter_data.cpp.

References CSG_String::AfterFirst(), CSG_String::asDouble(), CSG_String::BeforeFirst(), Set_Range(), SG_PARAMETER_DATA_SET_CHANGED, and SG_PARAMETER_DATA_SET_FALSE.

◆ Get_Max()

double CSG_Parameter_Range::Get_Max ( void  ) const

Definition at line 832 of file parameter_data.cpp.

References CSG_Parameter::asDouble(), and m_pMax.

Referenced by _Serialize(), _Set_String(), and CSG_Parameter::is_Value_Equal().

◆ Get_Max_Parameter()

CSG_Parameter_Double* CSG_Parameter_Range::Get_Max_Parameter ( void  ) const
inline

Definition at line 625 of file parameters.h.

Referenced by CSG_Parameters::Get_Parameter().

◆ Get_Min()

double CSG_Parameter_Range::Get_Min ( void  ) const

Definition at line 814 of file parameter_data.cpp.

References CSG_Parameter::asDouble(), and m_pMin.

Referenced by _Serialize(), _Set_String(), and CSG_Parameter::is_Value_Equal().

◆ Get_Min_Parameter()

CSG_Parameter_Double* CSG_Parameter_Range::Get_Min_Parameter ( void  ) const
inline

Definition at line 621 of file parameters.h.

Referenced by CSG_Parameters::Get_Parameter().

◆ Get_Range()

double CSG_Parameter_Range::Get_Range ( void  ) const
inline

Definition at line 617 of file parameters.h.

◆ Get_Type()

virtual TSG_Parameter_Type CSG_Parameter_Range::Get_Type ( void  ) const
inlinevirtual

Implements CSG_Parameter.

Definition at line 614 of file parameters.h.

References PARAMETER_TYPE_Range.

◆ is_Default()

bool CSG_Parameter_Range::is_Default ( void  ) const
virtual

Reimplemented from CSG_Parameter.

Definition at line 838 of file parameter_data.cpp.

References CSG_Parameter_Double::is_Default(), m_pMax, and m_pMin.

◆ Restore_Default()

bool CSG_Parameter_Range::Restore_Default ( void  )
virtual

Reimplemented from CSG_Parameter.

Definition at line 844 of file parameter_data.cpp.

References m_pMax, m_pMin, and CSG_Parameter::Restore_Default().

◆ Set_Max()

bool CSG_Parameter_Range::Set_Max ( double  Max)

Definition at line 820 of file parameter_data.cpp.

References CSG_Parameter::has_Changed(), m_pMax, and CSG_Parameter::Set_Value().

◆ Set_Min()

bool CSG_Parameter_Range::Set_Min ( double  Min)

Definition at line 802 of file parameter_data.cpp.

References CSG_Parameter::has_Changed(), m_pMin, and CSG_Parameter::Set_Value().

◆ Set_Range()

bool CSG_Parameter_Range::Set_Range ( double  Min,
double  Max 
)

Definition at line 783 of file parameter_data.cpp.

References m_pMax, m_pMin, and CSG_Parameter::Set_Value().

Referenced by _Serialize(), _Set_Value(), and CSG_Parameters::Serialize_Compatibility().

Friends And Related Function Documentation

◆ CSG_Parameters

friend class CSG_Parameters
friend

Definition at line 650 of file parameters.h.

Referenced by CSG_Parameter_Range().

Member Data Documentation

◆ m_pMax

CSG_Parameter_Double * CSG_Parameter_Range::m_pMax
protected

Definition at line 639 of file parameters.h.

Referenced by _Assign(), CSG_Parameter_Range(), Get_Max(), is_Default(), Restore_Default(), Set_Max(), and Set_Range().

◆ m_pMin

CSG_Parameter_Double* CSG_Parameter_Range::m_pMin
protected

Definition at line 639 of file parameters.h.

Referenced by _Assign(), CSG_Parameter_Range(), Get_Min(), is_Default(), Restore_Default(), Set_Min(), and Set_Range().

◆ m_pRange

CSG_Parameters* CSG_Parameter_Range::m_pRange
protected

Definition at line 637 of file parameters.h.

Referenced by CSG_Parameter_Range(), and ~CSG_Parameter_Range().

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