CSG_Parameter_Double Class Reference

#include <parameters.h>

Inheritance diagram for CSG_Parameter_Double:

Public Member Functions
virtual TSG_Parameter_Type	Get_Type (void) const
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
bool	Set_Collapsed (bool bOn=true)
bool	is_Collapsed (void) 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 bOn=false)
void	Set_UseInCMD (bool bOn=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 (CSG_Grid_Resampling 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_Grid_Resampling	asGrid_Resampling (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_Double (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_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 (CSG_Grid_Resampling Value)
virtual int	_Set_Value (void *Value)
virtual void *	_asPointer (void) const
virtual const SG_Char *	_asString (void) const

Protected Attributes
double	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 515 of file parameters.h.

Constructor & Destructor Documentation

CSG_Parameter_Double()

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

protected

Definition at line 519 of file parameter_data.cpp.

References CSG_Parameter_Value::CSG_Parameter_Value(), CSG_Parameters, and m_Value.

Referenced by CSG_Parameter_Degree::CSG_Parameter_Degree().

Member Function Documentation

_asDouble()

virtual double CSG_Parameter_Double::_asDouble ( void ) const

inlineprotectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 538 of file parameters.h.

References m_Value.

_asInt()

virtual int CSG_Parameter_Double::_asInt ( void ) const

inlineprotectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 537 of file parameters.h.

References m_Value.

_Assign()

bool CSG_Parameter_Double::_Assign ( CSG_Parameter * pSource )

protectedvirtual

Reimplemented from CSG_Parameter_Value.

Definition at line 578 of file parameter_data.cpp.

References CSG_Parameter_Value::_Assign(), _Set_Value(), and CSG_Parameter::asDouble().

_Serialize()

bool CSG_Parameter_Double::_Serialize ( CSG_MetaData & Entry, bool bSave )

protectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 586 of file parameter_data.cpp.

References CSG_String::asDouble(), CSG_MetaData::Fmt_Content(), CSG_MetaData::Get_Content(), m_Value, and SG_Get_Significant_Decimals().

_Set_String()

void CSG_Parameter_Double::_Set_String ( void )

protectedvirtual

Reimplemented from CSG_Parameter.

Reimplemented in CSG_Parameter_Degree.

Definition at line 572 of file parameter_data.cpp.

References CSG_Parameter::m_String, m_Value, and SG_Get_Significant_Decimals().

_Set_Value() [1/3]

int CSG_Parameter_Double::_Set_Value ( const CSG_String & Value )

protectedvirtual

Reimplemented from CSG_Parameter.

Reimplemented in CSG_Parameter_Degree.

Definition at line 559 of file parameter_data.cpp.

References _Set_Value(), CSG_String::asDouble(), and SG_PARAMETER_DATA_SET_FALSE.

_Set_Value() [2/3]

int CSG_Parameter_Double::_Set_Value ( double Value )

protectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 537 of file parameter_data.cpp.

References _Set_Value(), CSG_Parameter_Value::m_bMaximum, CSG_Parameter_Value::m_bMinimum, CSG_Parameter_Value::m_Maximum, CSG_Parameter_Value::m_Minimum, m_Value, SG_PARAMETER_DATA_SET_CHANGED, and SG_PARAMETER_DATA_SET_TRUE.

_Set_Value() [3/3]

int CSG_Parameter_Double::_Set_Value ( int Value )

protectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 532 of file parameter_data.cpp.

References _Set_Value().

Referenced by _Assign(), CSG_Parameter_Degree::_Set_Value(), _Set_Value(), _Set_Value(), and _Set_Value().

Get_Type()

virtual TSG_Parameter_Type CSG_Parameter_Double::Get_Type ( void ) const

inlinevirtual

Implements CSG_Parameter.

Reimplemented in CSG_Parameter_Degree.

Definition at line 519 of file parameters.h.

References PARAMETER_TYPE_Double.

is_Default()

bool CSG_Parameter_Double::is_Default ( void ) const

virtual

Reimplemented from CSG_Parameter.

Definition at line 526 of file parameter_data.cpp.

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

Friends And Related Symbol Documentation

CSG_Parameters

friend class CSG_Parameters

friend

Definition at line 544 of file parameters.h.

References CSG_Parameters.

Referenced by CSG_Parameter_Double(), and CSG_Parameters.

Member Data Documentation

m_Value

double CSG_Parameter_Double::m_Value

protected

Definition at line 528 of file parameters.h.

Referenced by _asDouble(), _asInt(), _Serialize(), _Set_String(), _Set_Value(), CSG_Parameter_Double(), and is_Default().

---

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

• parameters.h
• parameter_data.cpp