SAGA API v9.10
Loading...
Searching...
No Matches
CSG_Parameter Class Referenceabstract

#include <parameters.h>

Inheritance diagram for CSG_Parameter:
CSG_Parameter_Bool CSG_Parameter_Choice CSG_Parameter_Choices CSG_Parameter_Colors CSG_Parameter_Data_Object CSG_Parameter_Date CSG_Parameter_Fixed_Table CSG_Parameter_Font CSG_Parameter_Grid_System CSG_Parameter_List CSG_Parameter_Node CSG_Parameter_Parameters CSG_Parameter_Range CSG_Parameter_String CSG_Parameter_Table_Fields CSG_Parameter_Value

Public Member Functions

CSG_Parameters * Get_Parameters (void) const
CSG_Parameter * Get_Parent (void) const
class CSG_Data_Manager * Get_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_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 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_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 (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 (CSG_Grid_Resampling 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 _Assign (CSG_Parameter *pSource)
virtual bool _Serialize (CSG_MetaData &MetaData, bool bSave)

Protected Attributes

CSG_String m_String

Friends

class CSG_Parameters

Detailed Description

Definition at line 207 of file parameters.h.

Constructor & Destructor Documentation

◆ CSG_Parameter()

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

Definition at line 64 of file parameter.cpp.

References CSG_Parameter(), and CSG_Parameters.

Referenced by _Assign(), CSG_Parameter_Bool::_Assign(), CSG_Parameter_Choice::_Assign(), CSG_Parameter_Choices::_Assign(), CSG_Parameter_Colors::_Assign(), CSG_Parameter_Data_Object::_Assign(), CSG_Parameter_Date::_Assign(), CSG_Parameter_Fixed_Table::_Assign(), CSG_Parameter_Font::_Assign(), CSG_Parameter_Grid_System::_Assign(), CSG_Parameter_List::_Assign(), CSG_Parameter_Parameters::_Assign(), CSG_Parameter_Range::_Assign(), CSG_Parameter_String::_Assign(), CSG_Parameter_Table_Fields::_Assign(), CSG_Parameter_Value::_Assign(), CSG_Parameter_Grid_System::_Set_Value(), Assign(), CSG_Parameter(), CSG_Parameter_Bool::CSG_Parameter_Bool(), CSG_Parameter_Choice::CSG_Parameter_Choice(), CSG_Parameter_Choices::CSG_Parameter_Choices(), CSG_Parameter_Colors::CSG_Parameter_Colors(), CSG_Parameter_Data_Object::CSG_Parameter_Data_Object(), CSG_Parameter_Date::CSG_Parameter_Date(), CSG_Parameter_Fixed_Table::CSG_Parameter_Fixed_Table(), CSG_Parameter_Font::CSG_Parameter_Font(), CSG_Parameter_Grid_System::CSG_Parameter_Grid_System(), CSG_Parameter_List::CSG_Parameter_List(), CSG_Parameter_Node::CSG_Parameter_Node(), CSG_Parameter_Parameters::CSG_Parameter_Parameters(), CSG_Parameter_Range::CSG_Parameter_Range(), CSG_Parameter_String::CSG_Parameter_String(), CSG_Parameter_Table_Fields::CSG_Parameter_Table_Fields(), CSG_Parameter_Value::CSG_Parameter_Value(), CSG_Parameters, Get_Child(), Get_Parent(), is_Compatible(), is_Value_Equal(), and Set_Value().

◆ ~CSG_Parameter()

CSG_Parameter::~CSG_Parameter ( void )
protectedvirtual

Definition at line 86 of file parameter.cpp.

References SG_Free().

Member Function Documentation

◆ _asDouble()

double CSG_Parameter::_asDouble ( void ) const
protectedvirtual

Reimplemented in CSG_Parameter_Choice, CSG_Parameter_Date, CSG_Parameter_Double, CSG_Parameter_Grid, CSG_Parameter_Int, and CSG_Parameter_Table_Field.

Definition at line 1061 of file parameter.cpp.

Referenced by asDouble().

◆ _asInt()

int CSG_Parameter::_asInt ( void ) const
protectedvirtual

Reimplemented in CSG_Parameter_Bool, CSG_Parameter_Choice, CSG_Parameter_Colors, CSG_Parameter_Date, CSG_Parameter_Double, CSG_Parameter_Font, CSG_Parameter_Grid, CSG_Parameter_Int, CSG_Parameter_List, and CSG_Parameter_Table_Fields.

Definition at line 1060 of file parameter.cpp.

Referenced by asBool(), asColor(), and asInt().

◆ _asPointer()

void * CSG_Parameter::_asPointer ( void ) const
protectedvirtual

Reimplemented in CSG_Parameter_Colors, CSG_Parameter_Data_Object, CSG_Parameter_Fixed_Table, CSG_Parameter_Font, CSG_Parameter_Grid_System, CSG_Parameter_List, CSG_Parameter_Parameters, and CSG_Parameter_Table_Fields.

Definition at line 1062 of file parameter.cpp.

Referenced by asPointer().

◆ _Assign()

bool CSG_Parameter::_Assign ( CSG_Parameter * pSource)
protectedvirtual

Reimplemented in CSG_Parameter_Bool, CSG_Parameter_Choice, CSG_Parameter_Choices, CSG_Parameter_Colors, CSG_Parameter_Data_Object, CSG_Parameter_Data_Type, CSG_Parameter_Date, CSG_Parameter_Double, CSG_Parameter_File_Name, CSG_Parameter_Fixed_Table, CSG_Parameter_Font, CSG_Parameter_Grid, CSG_Parameter_Grid_System, CSG_Parameter_Int, CSG_Parameter_List, CSG_Parameter_Parameters, CSG_Parameter_PointCloud, CSG_Parameter_Range, CSG_Parameter_Shapes, CSG_Parameter_Shapes_List, CSG_Parameter_String, CSG_Parameter_Table_Field, CSG_Parameter_Table_Fields, and CSG_Parameter_Value.

Definition at line 1216 of file parameter.cpp.

References CSG_Parameter().

Referenced by Assign().

◆ _asString()

const SG_Char * CSG_Parameter::_asString ( void ) const
protectedvirtual

Definition at line 1063 of file parameter.cpp.

References m_String, and SG_Char.

Referenced by asString().

◆ _Serialize()

bool CSG_Parameter::_Serialize ( CSG_MetaData & MetaData,
bool bSave )
protectedvirtual

Reimplemented in CSG_Parameter_Bool, CSG_Parameter_Choice, CSG_Parameter_Choices, CSG_Parameter_Color, CSG_Parameter_Colors, CSG_Parameter_Data_Object, CSG_Parameter_Data_Type, CSG_Parameter_Date, CSG_Parameter_Double, CSG_Parameter_Fixed_Table, CSG_Parameter_Font, CSG_Parameter_Grid_System, CSG_Parameter_Int, CSG_Parameter_List, CSG_Parameter_Parameters, CSG_Parameter_Range, CSG_Parameter_String, CSG_Parameter_Table_Field, and CSG_Parameter_Table_Fields.

Definition at line 1258 of file parameter.cpp.

References CSG_MetaData::Set_Content().

Referenced by Serialize().

◆ _Set_String()

void CSG_Parameter::_Set_String ( void )
protectedvirtual

Reimplemented in CSG_Parameter_Bool, CSG_Parameter_Choice, CSG_Parameter_Choices, CSG_Parameter_Colors, CSG_Parameter_Data_Object, CSG_Parameter_Date, CSG_Parameter_Degree, CSG_Parameter_Double, CSG_Parameter_Fixed_Table, CSG_Parameter_Grid_System, CSG_Parameter_Int, CSG_Parameter_List, CSG_Parameter_Parameters, CSG_Parameter_Range, and CSG_Parameter_Table_Field.

Definition at line 925 of file parameter.cpp.

Referenced by Assign(), Check(), CSG_Parameters::Get_String(), has_Changed(), and Serialize().

◆ _Set_Value() [1/5]

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

Reimplemented in CSG_Parameter_Bool, CSG_Parameter_Choice, CSG_Parameter_Choices, CSG_Parameter_Color, CSG_Parameter_Colors, CSG_Parameter_Date, CSG_Parameter_Degree, CSG_Parameter_Double, CSG_Parameter_Font, CSG_Parameter_Grid_System, CSG_Parameter_Int, CSG_Parameter_Range, CSG_Parameter_String, CSG_Parameter_Table_Field, and CSG_Parameter_Table_Fields.

Definition at line 811 of file parameter.cpp.

References SG_PARAMETER_DATA_SET_FALSE.

◆ _Set_Value() [2/5]

int CSG_Parameter::_Set_Value ( CSG_Grid_Resampling Value)
protectedvirtual

Reimplemented in CSG_Parameter_Choice.

Definition at line 810 of file parameter.cpp.

References SG_PARAMETER_DATA_SET_FALSE.

◆ _Set_Value() [3/5]

int CSG_Parameter::_Set_Value ( double Value)
protectedvirtual

Reimplemented in CSG_Parameter_Bool, CSG_Parameter_Choice, CSG_Parameter_Date, CSG_Parameter_Double, and CSG_Parameter_Int.

Definition at line 809 of file parameter.cpp.

References SG_PARAMETER_DATA_SET_FALSE.

◆ _Set_Value() [4/5]

int CSG_Parameter::_Set_Value ( int Value)
protectedvirtual

Reimplemented in CSG_Parameter_Bool, CSG_Parameter_Choice, CSG_Parameter_Colors, CSG_Parameter_Date, CSG_Parameter_Double, CSG_Parameter_Font, CSG_Parameter_Int, and CSG_Parameter_Table_Field.

Definition at line 808 of file parameter.cpp.

References SG_PARAMETER_DATA_SET_FALSE.

Referenced by CSG_Parameter_Value::Set_Valid_Range(), Set_Value(), Set_Value(), Set_Value(), Set_Value(), and Set_Value().

◆ _Set_Value() [5/5]

int CSG_Parameter::_Set_Value ( void * Value)
protectedvirtual

Reimplemented in CSG_Parameter_Colors, CSG_Parameter_Data_Object, CSG_Parameter_Data_Object_Output, CSG_Parameter_Fixed_Table, CSG_Parameter_Grid, CSG_Parameter_Grid_System, CSG_Parameter_List, CSG_Parameter_PointCloud, CSG_Parameter_Shapes, CSG_Parameter_Table, and CSG_Parameter_TIN.

Definition at line 812 of file parameter.cpp.

References SG_PARAMETER_DATA_SET_FALSE.

◆ asBool()

bool CSG_Parameter::asBool ( void ) const
inline

Definition at line 286 of file parameters.h.

References _asInt().

Referenced by CSG_Parameter_Bool::_Assign(), is_Value_Equal(), SG_XML_Add_Parameter(), and CSG_Parameter_Bool::Toggle_Value().

◆ asChoice()

CSG_Parameter_Choice * CSG_Parameter::asChoice ( void ) const

Definition at line 1162 of file parameter.cpp.

References Get_Type(), PARAMETER_TYPE_Choice, and PARAMETER_TYPE_Data_Type.

Referenced by CSG_Parameter_Choice::_Assign(), CSG_Parameters::Add_Choice(), CSG_Parameters::Add_Grid_Resampling(), asGrid_Resampling(), Get_Description(), is_Compatible(), and SG_XML_Add_Parameter().

◆ asChoices()

CSG_Parameter_Choices * CSG_Parameter::asChoices ( void ) const

Definition at line 1164 of file parameter.cpp.

References Get_Type(), and PARAMETER_TYPE_Choices.

Referenced by CSG_Parameter_Choices::_Assign(), CSG_Parameters::Add_Choices(), Get_Description(), is_Compatible(), is_Value_Equal(), and SG_XML_Add_Parameter().

◆ asColor()

long CSG_Parameter::asColor ( void ) const
inline

Definition at line 288 of file parameters.h.

References _asInt().

◆ asColors()

CSG_Colors * CSG_Parameter::asColors ( void ) const

Definition at line 1066 of file parameter.cpp.

References asPointer(), Get_Type(), and PARAMETER_TYPE_Colors.

Referenced by CSG_Parameter_Colors::_Assign(), CSG_Parameters::Add_Colors(), CSG_Parameters::Add_Colors(), is_Value_Equal(), and CSG_Parameters::Serialize_Compatibility().

◆ asDataObject()

CSG_Data_Object * CSG_Parameter::asDataObject ( void ) const

Definition at line 1096 of file parameter.cpp.

References asPointer(), and is_DataObject().

Referenced by CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Grid_System::_Set_Value(), CSG_Parameter_Grid_List::Add_Item(), CSG_Parameter_Grids_List::Add_Item(), asGrid(), asGrids(), asPointCloud(), asShapes(), asTable(), asTIN(), Check(), CSG_Tool::DataObject_Set_History(), CSG_Parameters_Grid_Target::Get_Grid(), is_Value_Equal(), and CSG_Parameters::Set_History().

◆ asDataType()

CSG_Parameter_Data_Type * CSG_Parameter::asDataType ( void ) const

Definition at line 1161 of file parameter.cpp.

References Get_Type(), and PARAMETER_TYPE_Data_Type.

Referenced by CSG_Parameters::Add_Data_Type().

◆ asDate()

CSG_Parameter_Date * CSG_Parameter::asDate ( void ) const

Definition at line 1160 of file parameter.cpp.

References Get_Type(), and PARAMETER_TYPE_Date.

◆ asDouble()

double CSG_Parameter::asDouble ( void ) const
inline

Definition at line 289 of file parameters.h.

References _asDouble().

Referenced by CSG_Parameter_Grid::_asDouble(), CSG_Parameter_Table_Field::_asDouble(), CSG_Parameter_Date::_asInt(), CSG_Parameter_Double::_Assign(), CSG_Parameter_Grid_System::_Serialize(), CSG_Parameter_Degree::_Set_String(), CSG_Parameter_Date::_Set_Value(), CSG_Parameter_Double::is_Default(), is_Value_Equal(), CSG_Parameters_Grid_Target::On_Parameter_Changed(), CSG_Parameter_Value::Set_Valid_Range(), and SG_Get_Projected().

◆ asFilePath()

CSG_Parameter_File_Name * CSG_Parameter::asFilePath ( void ) const

Definition at line 1166 of file parameter.cpp.

References Get_Type(), and PARAMETER_TYPE_FilePath.

Referenced by CSG_Parameter_File_Name::_Assign(), and CSG_Parameters::Add_FilePath().

◆ asFont()

const SG_Char * CSG_Parameter::asFont ( void ) const

Definition at line 1067 of file parameter.cpp.

References asPointer(), Get_Type(), PARAMETER_TYPE_Font, and SG_Char.

◆ asGrid()

CSG_Grid * CSG_Parameter::asGrid ( void ) const

Definition at line 1097 of file parameter.cpp.

References asDataObject(), DATAOBJECT_CREATE, CSG_Data_Object::Get_ObjectType(), and SG_DATAOBJECT_TYPE_Grid.

Referenced by CSG_Parameters_Grid_Target::Get_Grid().

◆ asGrid_Resampling()

CSG_Grid_Resampling CSG_Parameter::asGrid_Resampling ( void ) const

Definition at line 1072 of file parameter.cpp.

References asChoice(), Bicubic_1, Bicubic_2, Bilinear, Get_Type(), Majority, Maximum, Mean_Cells, Mean_Nodes, Minimum, NearestNeighbour, PARAMETER_TYPE_Choice, and Undefined.

Referenced by CSG_Parameter_Choice::_Set_Value().

◆ asGrid_System()

CSG_Grid_System * CSG_Parameter::asGrid_System ( void ) const

Definition at line 1069 of file parameter.cpp.

References asPointer(), Get_Type(), and PARAMETER_TYPE_Grid_System.

Referenced by CSG_Parameters::Add_Grid_System(), Check(), CSG_Parameters_Grid_Target::Get_Grid(), CSG_Parameters_Grid_Target::Get_Grids(), CSG_Parameters::Get_String(), CSG_Parameter_Grid::Get_System(), CSG_Parameter_Grid_List::Get_System(), CSG_Parameter_Grids_List::Get_System(), CSG_Parameters_Grid_Target::Get_System(), is_Value_Equal(), CSG_Parameters::Serialize_Compatibility(), and CSG_Parameter_Grid_List::Update_Data().

◆ asGridList()

CSG_Parameter_Grid_List * CSG_Parameter::asGridList ( void ) const

Definition at line 1171 of file parameter.cpp.

References Get_Type(), and PARAMETER_TYPE_Grid_List.

Referenced by CSG_Parameter_Grid::_Set_Value(), and CSG_Parameter_Grid_List::Add_Item().

◆ asGrids()

CSG_Grids * CSG_Parameter::asGrids ( void ) const

Definition at line 1098 of file parameter.cpp.

References asDataObject(), DATAOBJECT_CREATE, CSG_Data_Object::Get_ObjectType(), and SG_DATAOBJECT_TYPE_Grids.

Referenced by asTable(), and CSG_Parameters_Grid_Target::Get_Grids().

◆ asGridsList()

CSG_Parameter_Grids_List * CSG_Parameter::asGridsList ( void ) const

Definition at line 1172 of file parameter.cpp.

References Get_Type(), and PARAMETER_TYPE_Grids_List.

Referenced by CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Grid_List::Add_Item(), and CSG_Parameter_Grids_List::Add_Item().

◆ asInt()

int CSG_Parameter::asInt ( void ) const
inline

Definition at line 287 of file parameters.h.

References _asInt().

Referenced by CSG_Parameter_Grid::_asInt(), CSG_Parameter_Int::_Assign(), CSG_Parameter_Font::_Serialize(), CSG_Parameter_Table_Field::_Serialize(), CSG_Parameter_Choice::_Set_Value(), CSG_Parameter_Bool::is_Default(), CSG_Parameter_Choice::is_Default(), CSG_Parameter_Int::is_Default(), is_Value_Equal(), CSG_Parameters_Grid_Target::On_Parameters_Enable(), CSG_Parameters_Point_Search::On_Parameters_Enable(), CSG_Parameter_Value::Set_Valid_Range(), Set_Value(), and CSG_Parameter_Choice::Toggle_Value().

◆ asList()

CSG_Parameter_List * CSG_Parameter::asList ( void ) const

Definition at line 1170 of file parameter.cpp.

References is_DataObject_List().

Referenced by CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Grid_System::_Set_Value(), CSG_Parameter_Grid_List::Add_Item(), CSG_Parameter_Grids_List::Add_Item(), Check(), CSG_Tool::DataObject_Set_History(), is_Value_Equal(), CSG_Parameters::Serialize_Compatibility(), and CSG_Parameters::Set_History().

◆ asParameters()

CSG_Parameters * CSG_Parameter::asParameters ( void ) const

Definition at line 1068 of file parameter.cpp.

References asPointer(), CSG_Parameters, Get_Type(), and PARAMETER_TYPE_Parameters.

Referenced by CSG_Parameter_Parameters::_Assign(), CSG_Parameters::Add_Parameters(), Check(), Get_Description(), CSG_Parameters::Get_Parameter(), is_Compatible(), is_Value_Equal(), CSG_Parameters_CRSPicker::On_Parameter_Changed(), CSG_Parameters::Serialize_Compatibility(), CSG_Parameters::Set_History(), and SG_XML_Add_Parameter().

◆ asPointCloud()

CSG_PointCloud * CSG_Parameter::asPointCloud ( void ) const

Definition at line 1100 of file parameter.cpp.

References asDataObject(), DATAOBJECT_CREATE, CSG_Data_Object::Get_ObjectType(), and SG_DATAOBJECT_TYPE_PointCloud.

◆ asPointCloudList()

CSG_Parameter_PointCloud_List * CSG_Parameter::asPointCloudList ( void ) const

Definition at line 1176 of file parameter.cpp.

References Get_Type(), and PARAMETER_TYPE_PointCloud_List.

◆ asPointer()

void * CSG_Parameter::asPointer ( void ) const
inline

Definition at line 291 of file parameters.h.

References _asPointer().

Referenced by CSG_Parameter_Grid::_Assign(), asColors(), asDataObject(), asFont(), asGrid_System(), asParameters(), asTable(), and CSG_Parameters_Grid_Target::Get_Grids().

◆ asRange()

CSG_Parameter_Range * CSG_Parameter::asRange ( void ) const

Definition at line 1165 of file parameter.cpp.

References Get_Type(), and PARAMETER_TYPE_Range.

Referenced by CSG_Parameter_Range::_Assign(), CSG_Parameters::Get_Parameter(), is_Value_Equal(), and CSG_Parameters::Serialize_Compatibility().

◆ asShapes()

CSG_Shapes * CSG_Parameter::asShapes ( void ) const

Definition at line 1103 of file parameter.cpp.

References asDataObject(), DATAOBJECT_CREATE, CSG_Data_Object::Get_ObjectType(), SG_DATAOBJECT_TYPE_PointCloud, and SG_DATAOBJECT_TYPE_Shapes.

Referenced by CSG_Parameters_Point_Search::On_Parameter_Changed().

◆ asShapesList()

CSG_Parameter_Shapes_List * CSG_Parameter::asShapesList ( void ) const

Definition at line 1174 of file parameter.cpp.

References Get_Type(), and PARAMETER_TYPE_Shapes_List.

◆ Assign()

bool CSG_Parameter::Assign ( CSG_Parameter * pSource)

Definition at line 1196 of file parameter.cpp.

References _Assign(), _Set_String(), CSG_Parameter(), Get_Type(), is_Collapsed(), and Set_Collapsed().

Referenced by CSG_Parameters::Assign_Values(), CSG_Parameters::Set_Parameter(), and Set_Value().

◆ asString()

const SG_Char * CSG_Parameter::asString ( void ) const
inline

Definition at line 290 of file parameters.h.

References _asString(), and SG_Char.

Referenced by CSG_Parameter_Table_Fields::_Assign(), CSG_Parameter_Choice::_Serialize(), CSG_Parameter_Choices::_Serialize(), CSG_Parameter_Date::_Serialize(), CSG_Parameter_Int::_Serialize(), CSG_Parameter_Table_Field::_Serialize(), CSG_Parameters::Get_String(), is_Default(), is_Value_Equal(), CSG_Projections::Parse(), and CSG_Projections::Parse().

◆ asTable()

CSG_Table * CSG_Parameter::asTable ( void ) const

Definition at line 1118 of file parameter.cpp.

References asDataObject(), asGrids(), asPointer(), DATAOBJECT_CREATE, CSG_Data_Object::Get_ObjectType(), Get_Type(), PARAMETER_TYPE_FixedTable, PARAMETER_TYPE_Grids, SG_DATAOBJECT_TYPE_PointCloud, SG_DATAOBJECT_TYPE_Shapes, SG_DATAOBJECT_TYPE_Table, and SG_DATAOBJECT_TYPE_TIN.

Referenced by CSG_Parameter_Fixed_Table::_Assign(), CSG_Parameters::Add_FixedTable(), Get_Description(), CSG_Parameter_Table_Field::Get_Table(), CSG_Parameter_Table_Fields::Get_Table(), is_Compatible(), is_Value_Equal(), CSG_Parameters::Serialize_Compatibility(), and SG_XML_Add_Parameter().

◆ asTableFields()

CSG_Parameter_Table_Fields * CSG_Parameter::asTableFields ( void ) const

Definition at line 1167 of file parameter.cpp.

References Get_Type(), and PARAMETER_TYPE_Table_Fields.

◆ asTableList()

CSG_Parameter_Table_List * CSG_Parameter::asTableList ( void ) const

Definition at line 1173 of file parameter.cpp.

References Get_Type(), and PARAMETER_TYPE_Table_List.

◆ asTIN()

CSG_TIN * CSG_Parameter::asTIN ( void ) const

Definition at line 1099 of file parameter.cpp.

References asDataObject(), DATAOBJECT_CREATE, CSG_Data_Object::Get_ObjectType(), and SG_DATAOBJECT_TYPE_TIN.

◆ asTINList()

CSG_Parameter_TIN_List * CSG_Parameter::asTINList ( void ) const

Definition at line 1175 of file parameter.cpp.

References Get_Type(), and PARAMETER_TYPE_TIN_List.

◆ asValue()

CSG_Parameter_Value * CSG_Parameter::asValue ( void ) const

Definition at line 1146 of file parameter.cpp.

References Get_Type(), PARAMETER_TYPE_Color, PARAMETER_TYPE_Degree, PARAMETER_TYPE_Double, PARAMETER_TYPE_Int, and PARAMETER_TYPE_Table_Field.

Referenced by CSG_Parameter_Value::_Assign(), Get_Description(), and SG_XML_Add_Parameter().

◆ Check()

bool CSG_Parameter::Check ( bool bSilent = true)

Definition at line 983 of file parameter.cpp.

References _Set_String(), asDataObject(), asGrid_System(), asList(), asParameters(), DATAOBJECT_CREATE, DATAOBJECT_NOTSET, CSG_Parameter_List::Del_Item(), CSG_Parameter_List::Get_Item(), Get_Type(), CSG_Data_Manager::Grid(), CSG_Data_Manager::Grids(), is_DataObject(), is_DataObject_List(), is_Enabled(), is_Input(), is_Optional(), is_Output(), PARAMETER_TYPE_Grid_System, PARAMETER_TYPE_Parameters, Set_Value(), and CSG_Parameter_List::Update_Data().

◆ Cmp_Identifier()

bool CSG_Parameter::Cmp_Identifier ( const CSG_String & Identifier) const

Definition at line 568 of file parameter.cpp.

Referenced by Get_Type(), CSG_Parameters_CRSPicker::On_Parameter_Changed(), CSG_Parameters_Grid_Target::On_Parameter_Changed(), and CSG_Parameters_Point_Search::On_Parameters_Enable().

◆ do_UseInCMD()

bool CSG_Parameter::do_UseInCMD ( void ) const

Definition at line 187 of file parameter.cpp.

References do_UseInCMD(), Get_Parent(), and PARAMETER_NOT_FOR_CMD.

Referenced by do_UseInCMD(), Get_Description(), CSG_Tool::Get_Summary(), is_Enabled(), and SG_XML_Add_Parameter().

◆ do_UseInGUI()

bool CSG_Parameter::do_UseInGUI ( void ) const

Definition at line 181 of file parameter.cpp.

References do_UseInGUI(), Get_Parent(), and PARAMETER_NOT_FOR_GUI.

Referenced by do_UseInGUI(), Get_Description(), is_Enabled(), and SG_XML_Add_Parameter().

◆ Get_Child()

CSG_Parameter * CSG_Parameter::Get_Child ( int iChild) const
inline

Definition at line 260 of file parameters.h.

References CSG_Parameter().

Referenced by CSG_Parameter_Grid::_asDouble(), CSG_Parameter_Table_Field::_asDouble(), CSG_Parameter_Grid::_asInt(), CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Grid_System::_Set_Value(), CSG_Parameter_PointCloud::_Set_Value(), CSG_Parameter_Shapes::_Set_Value(), CSG_Parameter_Table::_Set_Value(), CSG_Parameter_Table_Field::_Set_Value(), CSG_Parameter_TIN::_Set_Value(), CSG_Parameters_Grid_Target::Add_Grid(), CSG_Parameters_Grid_Target::Add_Grids(), CSG_Parameter_Grid_List::Add_Item(), CSG_Parameter_Grids_List::Add_Item(), CSG_Parameters::Del_Parameter(), and Set_Children_Enabled().

◆ Get_Children_Count()

int CSG_Parameter::Get_Children_Count ( void ) const
inline

Definition at line 259 of file parameters.h.

Referenced by CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Grid_System::_Set_Value(), CSG_Parameter_PointCloud::_Set_Value(), CSG_Parameter_Shapes::_Set_Value(), CSG_Parameter_Table::_Set_Value(), CSG_Parameter_TIN::_Set_Value(), CSG_Parameter_Grid::Add_Default(), CSG_Parameter_Table_Field::Add_Default(), CSG_Parameters_Grid_Target::Add_Grid(), CSG_Parameters_Grid_Target::Add_Grids(), CSG_Parameter_Grid_List::Add_Item(), CSG_Parameter_Grids_List::Add_Item(), CSG_Parameters::Del_Parameter(), Set_Children_Enabled(), and CSG_Parameter_Grid_List::Update_Data().

◆ Get_CmdID()

CSG_String CSG_Parameter::Get_CmdID ( void ) const

Constructs a command line parser conform identifier.

Definition at line 578 of file parameter.cpp.

References Get_Identifier(), Get_Parameters(), CSG_String::Length(), and CSG_String::Replace().

Referenced by Get_Type().

◆ Get_DataObject_Type()

TSG_Data_Object_Type CSG_Parameter::Get_DataObject_Type ( void ) const

Definition at line 534 of file parameter.cpp.

References Get_DataObject_Type(), Get_Type(), PARAMETER_TYPE_DataObject_Output, PARAMETER_TYPE_Grid, PARAMETER_TYPE_Grid_List, PARAMETER_TYPE_Grids, PARAMETER_TYPE_Grids_List, PARAMETER_TYPE_PointCloud, PARAMETER_TYPE_PointCloud_List, PARAMETER_TYPE_Shapes, PARAMETER_TYPE_Shapes_List, PARAMETER_TYPE_Table, PARAMETER_TYPE_Table_List, PARAMETER_TYPE_TIN, PARAMETER_TYPE_TIN_List, SG_DATAOBJECT_TYPE_Grid, SG_DATAOBJECT_TYPE_Grids, SG_DATAOBJECT_TYPE_PointCloud, SG_DATAOBJECT_TYPE_Shapes, SG_DATAOBJECT_TYPE_Table, SG_DATAOBJECT_TYPE_TIN, and SG_DATAOBJECT_TYPE_Undefined.

Referenced by Get_DataObject_Type(), Get_Description(), and SG_XML_Add_Parameter().

◆ Get_Default()

const CSG_String & CSG_Parameter::Get_Default ( void ) const

Definition at line 960 of file parameter.cpp.

Referenced by CSG_Parameter_Bool::is_Default(), CSG_Parameter_Choice::is_Default(), CSG_Parameter_Double::is_Default(), CSG_Parameter_Int::is_Default(), and SG_XML_Add_Parameter().

◆ Get_Description() [1/3]

CSG_String CSG_Parameter::Get_Description ( int Flags) const

Definition at line 623 of file parameter.cpp.

References Get_Description(), and SG_T.

◆ Get_Description() [2/3]

CSG_String CSG_Parameter::Get_Description ( int Flags,
const SG_Char * Separator ) const

Definition at line 629 of file parameter.cpp.

References _TL, asChoice(), asChoices(), asParameters(), asTable(), asValue(), do_UseInCMD(), do_UseInGUI(), CSG_String::Format(), CSG_Parameter_Choice::Get_Count(), CSG_Parameters::Get_Count(), Get_DataObject_Type(), Get_Description(), CSG_Table::Get_Field_Count(), CSG_Parameter_Choices::Get_Item_Count(), Get_Name(), Get_Type(), Get_Type_Name(), is_DataObject(), is_DataObject_List(), is_Input(), is_Optional(), PARAMETER_DESCRIPTION_NAME, PARAMETER_DESCRIPTION_OPTIONAL, PARAMETER_DESCRIPTION_PROPERTIES, PARAMETER_DESCRIPTION_TEXT, PARAMETER_DESCRIPTION_TYPE, PARAMETER_TYPE_Choice, PARAMETER_TYPE_Choices, PARAMETER_TYPE_Data_Type, PARAMETER_TYPE_DataObject_Output, PARAMETER_TYPE_Degree, PARAMETER_TYPE_Double, PARAMETER_TYPE_FixedTable, PARAMETER_TYPE_Int, PARAMETER_TYPE_Parameters, SEPARATE, SG_Char, SG_Data_Type_Get_Name(), SG_Get_DataObject_Name(), and SG_T.

◆ Get_Description() [3/3]

const SG_Char * CSG_Parameter::Get_Description ( void ) const

Definition at line 617 of file parameter.cpp.

References SG_Char.

Referenced by Get_Description(), Get_Description(), CSG_Tool::Get_Summary(), Get_Type(), and SG_XML_Add_Parameter().

◆ Get_Identifier()

const SG_Char * CSG_Parameter::Get_Identifier ( void ) const

Definition at line 562 of file parameter.cpp.

References SG_Char.

Referenced by CSG_Parameter_Parameters::_Serialize(), CSG_Parameters::Add_Bool(), CSG_Parameters::Add_Choice(), CSG_Parameters::Add_Color(), CSG_Parameters::Add_Colors(), CSG_Parameters::Add_Date(), CSG_Parameter_Grid::Add_Default(), CSG_Parameter_Table_Field::Add_Default(), CSG_Parameters::Add_Degree(), CSG_Parameters::Add_Double(), CSG_Parameters::Add_FilePath(), CSG_Parameters::Add_FixedTable(), CSG_Parameters::Add_Font(), CSG_Parameters::Add_Grid(), CSG_Parameters::Add_Grid(), CSG_Parameters_Grid_Target::Add_Grid(), CSG_Parameters::Add_Grid_List(), CSG_Parameters::Add_Grid_List(), CSG_Parameters::Add_Grid_or_Const(), CSG_Parameters::Add_Grid_Output(), CSG_Parameters::Add_Grid_System(), CSG_Parameters::Add_Grids(), CSG_Parameters_Grid_Target::Add_Grids(), CSG_Parameters::Add_Grids_List(), CSG_Parameters::Add_Info_Range(), CSG_Parameters::Add_Info_String(), CSG_Parameters::Add_Info_Value(), CSG_Parameters::Add_Int(), CSG_Parameters::Add_Node(), CSG_Parameters::Add_Parameters(), CSG_Parameters::Add_PointCloud(), CSG_Parameters::Add_PointCloud_List(), CSG_Parameters::Add_PointCloud_Output(), CSG_Parameters::Add_Range(), CSG_Parameters::Add_Shapes(), CSG_Parameters::Add_Shapes_List(), CSG_Parameters::Add_Shapes_Output(), CSG_Parameters::Add_String(), CSG_Parameters::Add_Table(), CSG_Parameters::Add_Table_Field(), CSG_Parameters::Add_Table_Field_or_Const(), CSG_Parameters::Add_Table_Fields(), CSG_Parameters::Add_Table_List(), CSG_Parameters::Add_Table_Output(), CSG_Parameters::Add_TIN(), CSG_Parameters::Add_TIN_List(), CSG_Parameters::Add_TIN_Output(), CSG_Parameters::Add_Value(), CSG_Parameters::Assign_Parameters(), CSG_Parameters::Assign_Values(), CSG_Parameters::Create(), CSG_Parameters_Grid_Target::Create(), CSG_Tool_Chain::Create(), CSG_Tool::DataObject_Set_History(), CSG_Parameters::Del_Parameter(), Get_CmdID(), CSG_Tool::Get_Summary(), Get_Type(), CSG_Parameters_Grid_Target::On_Parameter_Changed(), Serialize(), CSG_Parameters::Set_History(), and SG_XML_Add_Parameter().

◆ Get_Manager()

CSG_Data_Manager * CSG_Parameter::Get_Manager ( void ) const

Definition at line 112 of file parameter.cpp.

Referenced by CSG_Parameter_List::_Assign(), CSG_Parameter_Data_Object::_Serialize(), CSG_Parameter_List::_Serialize(), CSG_Parameter_Data_Object_Output::_Set_Value(), and CSG_Parameter_Grid_System::_Set_Value().

◆ Get_Name()

const SG_Char * CSG_Parameter::Get_Name ( void ) const

Definition at line 604 of file parameter.cpp.

References SG_Char.

Referenced by CSG_Tool::DataObject_Set_History(), Get_Description(), CSG_Parameters::Get_String(), CSG_Tool::Get_Summary(), Get_Type(), Serialize(), CSG_Parameters::Set_History(), and SG_XML_Add_Parameter().

◆ Get_Parameters()

CSG_Parameters * CSG_Parameter::Get_Parameters ( void ) const

Definition at line 100 of file parameter.cpp.

References CSG_Parameters.

Referenced by CSG_Tool::_On_Parameter_Changed(), CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Grid_System::_Set_Value(), CSG_Parameter_Shapes::_Set_Value(), CSG_Parameter_Grid::Add_Default(), CSG_Parameter_Table_Field::Add_Default(), Get_CmdID(), Serialize(), and CSG_Parameter_Grid_List::Update_Data().

◆ Get_Parent()

CSG_Parameter * CSG_Parameter::Get_Parent ( void ) const

Definition at line 106 of file parameter.cpp.

References CSG_Parameter().

Referenced by CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Grid_List::Add_Item(), CSG_Parameter_Grids_List::Add_Item(), CSG_Parameters::Del_Parameter(), do_UseInCMD(), do_UseInGUI(), CSG_Parameters_Grid_Target::Get_Grid(), CSG_Parameters_Grid_Target::Get_Grids(), CSG_Parameter_Grid::Get_System(), CSG_Parameter_Grid_List::Get_System(), CSG_Parameter_Grids_List::Get_System(), CSG_Parameter_Table_Field::Get_Table(), CSG_Parameter_Table_Fields::Get_Table(), CSG_Parameters::Set_History(), SG_XML_Add_Parameter(), and CSG_Parameter_Grid_List::Update_Data().

◆ Get_Type()

virtual TSG_Parameter_Type CSG_Parameter::Get_Type ( void ) const
pure virtual

Implemented in CSG_Parameter_Bool, CSG_Parameter_Choice, CSG_Parameter_Choices, CSG_Parameter_Color, CSG_Parameter_Colors, CSG_Parameter_Data_Object_Output, CSG_Parameter_Data_Type, CSG_Parameter_Date, CSG_Parameter_Degree, CSG_Parameter_Double, CSG_Parameter_File_Name, CSG_Parameter_Fixed_Table, CSG_Parameter_Font, CSG_Parameter_Grid, CSG_Parameter_Grid_List, CSG_Parameter_Grid_System, CSG_Parameter_Grids, CSG_Parameter_Grids_List, CSG_Parameter_Int, CSG_Parameter_Node, CSG_Parameter_Parameters, CSG_Parameter_PointCloud, CSG_Parameter_PointCloud_List, CSG_Parameter_Range, CSG_Parameter_Shapes, CSG_Parameter_Shapes_List, CSG_Parameter_String, CSG_Parameter_Table, CSG_Parameter_Table_Field, CSG_Parameter_Table_Fields, CSG_Parameter_Table_List, CSG_Parameter_Text, CSG_Parameter_TIN, and CSG_Parameter_TIN_List.

References Cmp_Identifier(), Get_CmdID(), Get_Description(), Get_Identifier(), Get_Name(), Get_Type_Identifier(), Get_Type_Name(), is_Enabled(), Set_Collapsed(), Set_Description(), Set_Enabled(), Set_Name(), and SG_Char.

Referenced by CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_PointCloud::_Set_Value(), CSG_Parameter_Shapes::_Set_Value(), CSG_Parameter_Table::_Set_Value(), CSG_Parameter_TIN::_Set_Value(), CSG_Parameters::Add_Grid(), CSG_Parameters_Grid_Target::Add_Grid(), CSG_Parameters::Add_Grid_List(), CSG_Parameters::Add_Grids(), CSG_Parameters_Grid_Target::Add_Grids(), CSG_Parameters::Add_Grids_List(), CSG_Parameter_Grid_List::Add_Item(), CSG_Parameter_Grids_List::Add_Item(), CSG_Parameters::Add_Table_Field(), CSG_Parameters::Add_Table_Fields(), asChoice(), asChoices(), asColors(), asDataType(), asDate(), asFilePath(), asFont(), asGrid_Resampling(), asGrid_System(), asGridList(), asGridsList(), asParameters(), asPointCloudList(), asRange(), asShapesList(), Assign(), CSG_Parameters::Assign_Values(), asTable(), asTableFields(), asTableList(), asTINList(), asValue(), Check(), Get_DataObject_Type(), Get_Description(), CSG_Parameters_Grid_Target::Get_Grid(), CSG_Parameters_Grid_Target::Get_Grids(), CSG_Parameters::Get_Parameter(), CSG_Parameters::Get_String(), CSG_Tool::Get_Summary(), Get_Type_Identifier(), Get_Type_Name(), is_Compatible(), is_DataObject(), is_DataObject_List(), is_Option(), is_Parameters(), is_Serializable(), is_Value_Equal(), Serialize(), CSG_Parameters::Set_History(), CSG_Parameters::Set_Parameter(), CSG_Parameters::Set_Parameter(), CSG_Parameters::Set_Parameter(), CSG_Parameters::Set_Parameter(), CSG_Parameters::Set_Parameter(), CSG_Parameters::Set_Parameter(), CSG_Parameter_Value::Set_Valid_Range(), Set_Value(), and SG_XML_Add_Parameter().

◆ Get_Type_Identifier()

CSG_String CSG_Parameter::Get_Type_Identifier ( void ) const

Definition at line 123 of file parameter.cpp.

References Get_Type(), and SG_Parameter_Type_Get_Identifier().

Referenced by CSG_Parameter_Parameters::_Serialize(), CSG_Tool::DataObject_Set_History(), Get_Type(), Serialize(), and CSG_Parameters::Set_History().

◆ Get_Type_Name()

CSG_String CSG_Parameter::Get_Type_Name ( void ) const

Definition at line 129 of file parameter.cpp.

References Get_Type(), and SG_Parameter_Type_Get_Name().

Referenced by Get_Description(), Get_Type(), and SG_XML_Add_Parameter().

◆ has_Changed()

bool CSG_Parameter::has_Changed ( int Check_Flags = PARAMETER_CHECK_ALL)

Definition at line 917 of file parameter.cpp.

References _Set_String().

Referenced by CSG_Parameter_Grid_System::_Set_Value(), CSG_Parameters::Load(), CSG_Parameter_Range::Set_Max(), CSG_Parameter_Range::Set_Min(), CSG_Parameter_Value::Set_Valid_Range(), Set_Value(), Set_Value(), Set_Value(), Set_Value(), and Set_Value().

◆ ignore_Projection() [1/2]

void CSG_Parameter::ignore_Projection ( bool bIgnore)

Definition at line 193 of file parameter.cpp.

References PARAMETER_IGNORE_PROJECTION.

◆ ignore_Projection() [2/2]

bool CSG_Parameter::ignore_Projection ( void ) const
inline

Definition at line 255 of file parameters.h.

References PARAMETER_IGNORE_PROJECTION.

◆ is_Collapsed()

bool CSG_Parameter::is_Collapsed ( void ) const
inline

Definition at line 233 of file parameters.h.

References PARAMETER_GUI_COLLAPSED.

Referenced by Assign(), and Set_Collapsed().

◆ is_Compatible()

bool CSG_Parameter::is_Compatible ( CSG_Parameter * pParameter) const

Definition at line 352 of file parameter.cpp.

References asChoice(), asChoices(), asParameters(), asTable(), CSG_Parameter(), CSG_Parameter_Choice::Get_Count(), CSG_Parameters::Get_Count(), CSG_Parameter_Choice::Get_Item(), CSG_Parameter_Choices::Get_Item(), CSG_Parameter_Choices::Get_Item_Count(), CSG_Parameters::Get_Parameter(), Get_Type(), is_Compatible(), CSG_Table::is_Compatible(), PARAMETER_TYPE_Choice, PARAMETER_TYPE_Choices, PARAMETER_TYPE_Data_Type, PARAMETER_TYPE_FixedTable, PARAMETER_TYPE_Parameters, and SG_STR_CMP.

Referenced by is_Compatible().

◆ is_DataObject()

bool CSG_Parameter::is_DataObject ( void ) const

Definition at line 291 of file parameter.cpp.

References Get_Type(), PARAMETER_TYPE_DataObject_Output, PARAMETER_TYPE_Grid, PARAMETER_TYPE_Grids, PARAMETER_TYPE_PointCloud, PARAMETER_TYPE_Shapes, PARAMETER_TYPE_Table, and PARAMETER_TYPE_TIN.

Referenced by CSG_Parameter_Grid_System::_Set_Value(), asDataObject(), Check(), CSG_Tool::DataObject_Set_History(), Get_Description(), Serialize(), and CSG_Parameters::Set_History().

◆ is_DataObject_List()

bool CSG_Parameter::is_DataObject_List ( void ) const

Definition at line 310 of file parameter.cpp.

References Get_Type(), PARAMETER_TYPE_Grid_List, PARAMETER_TYPE_Grids_List, PARAMETER_TYPE_PointCloud_List, PARAMETER_TYPE_Shapes_List, PARAMETER_TYPE_Table_List, and PARAMETER_TYPE_TIN_List.

Referenced by CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Grid_System::_Set_Value(), CSG_Parameter_Grid_List::Add_Item(), CSG_Parameter_Grids_List::Add_Item(), asList(), Check(), CSG_Tool::DataObject_Set_History(), Get_Description(), Serialize(), and CSG_Parameters::Set_History().

◆ is_Default()

bool CSG_Parameter::is_Default ( void ) const
virtual

Reimplemented in CSG_Parameter_Bool, CSG_Parameter_Choice, CSG_Parameter_Double, CSG_Parameter_Int, and CSG_Parameter_Range.

Definition at line 966 of file parameter.cpp.

References asString().

◆ is_Enabled()

bool CSG_Parameter::is_Enabled ( bool bCheckEnv = true) const

Definition at line 224 of file parameter.cpp.

References do_UseInCMD(), and do_UseInGUI().

Referenced by Check(), CSG_Parameters::Get_String(), Get_Type(), and CSG_Parameters::Set_History().

◆ is_Information()

bool CSG_Parameter::is_Information ( void ) const
inline

Definition at line 239 of file parameters.h.

References PARAMETER_INFORMATION.

Referenced by CSG_Parameter_Range::CSG_Parameter_Range(), CSG_Parameters::Get_String(), is_Option(), is_Serializable(), Serialize(), and CSG_Parameters::Set_History().

◆ is_Input()

bool CSG_Parameter::is_Input ( void ) const
inline

Definition at line 236 of file parameters.h.

References PARAMETER_INPUT.

Referenced by CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Shapes::_Set_Value(), CSG_Parameter_Grid::Add_Default(), CSG_Parameter_Grid_List::Add_Item(), Check(), Get_Description(), CSG_Tool::Get_Summary(), CSG_Parameters::Set_History(), and SG_XML_Add_Parameter().

◆ is_Option()

bool CSG_Parameter::is_Option ( void ) const

Definition at line 254 of file parameter.cpp.

References Get_Type(), is_Information(), PARAMETER_TYPE_Bool, PARAMETER_TYPE_Choice, PARAMETER_TYPE_Choices, PARAMETER_TYPE_Color, PARAMETER_TYPE_Colors, PARAMETER_TYPE_Data_Type, PARAMETER_TYPE_Date, PARAMETER_TYPE_Degree, PARAMETER_TYPE_Double, PARAMETER_TYPE_FilePath, PARAMETER_TYPE_FixedTable, PARAMETER_TYPE_Font, PARAMETER_TYPE_Grid_System, PARAMETER_TYPE_Int, PARAMETER_TYPE_Parameters, PARAMETER_TYPE_Range, PARAMETER_TYPE_String, PARAMETER_TYPE_Table_Field, PARAMETER_TYPE_Table_Fields, and PARAMETER_TYPE_Text.

Referenced by CSG_Parameters::Get_String(), CSG_Tool::Get_Summary(), Serialize(), CSG_Parameters::Set_History(), and SG_XML_Add_Parameter().

◆ is_Optional()

bool CSG_Parameter::is_Optional ( void ) const
inline

Definition at line 238 of file parameters.h.

References PARAMETER_OPTIONAL.

Referenced by CSG_Parameter_Data_Object::_Set_String(), CSG_Parameter_PointCloud::_Set_Value(), CSG_Parameter_Shapes::_Set_Value(), CSG_Parameter_Table::_Set_Value(), CSG_Parameter_Table_Field::_Set_Value(), CSG_Parameter_TIN::_Set_Value(), CSG_Parameter_Grid::Add_Default(), CSG_Parameter_Table_Field::Add_Default(), Check(), Get_Description(), CSG_Parameters_Grid_Target::Get_Grid(), CSG_Parameters_Grid_Target::Get_Grids(), CSG_Parameter_Data_Object::is_Valid(), and SG_XML_Add_Parameter().

◆ is_Output()

bool CSG_Parameter::is_Output ( void ) const
inline

Definition at line 237 of file parameters.h.

References PARAMETER_OUTPUT.

Referenced by CSG_Parameter_Data_Object::_Set_String(), CSG_Parameter_Grid::_Set_Value(), Check(), CSG_Tool::Get_Summary(), and SG_XML_Add_Parameter().

◆ is_Parameters()

bool CSG_Parameter::is_Parameters ( void ) const

Definition at line 328 of file parameter.cpp.

References Get_Type(), and PARAMETER_TYPE_Parameters.

Referenced by CSG_Parameters::Set_History().

◆ is_Serializable()

bool CSG_Parameter::is_Serializable ( void ) const

Definition at line 334 of file parameter.cpp.

References Get_Type(), is_Information(), PARAMETER_TYPE_DataObject_Output, PARAMETER_TYPE_Node, PARAMETER_TYPE_String, and PARAMETER_TYPE_Undefined.

◆ is_Valid()

virtual bool CSG_Parameter::is_Valid ( void ) const
inlinevirtual

Reimplemented in CSG_Parameter_Data_Object, and CSG_Parameter_String.

Definition at line 235 of file parameters.h.

Referenced by CSG_Parameter_Grid_List::Add_Item().

◆ is_Value_Equal()

bool CSG_Parameter::is_Value_Equal ( CSG_Parameter * pParameter) const

Definition at line 411 of file parameter.cpp.

References asBool(), asChoices(), asColors(), asDataObject(), asDouble(), asGrid_System(), asInt(), asList(), asParameters(), asRange(), asString(), CSG_Table_Record::asString(), asTable(), CSG_Parameter(), CSG_Colors::Get_Color(), CSG_Colors::Get_Count(), CSG_Parameters::Get_Count(), CSG_Table::Get_Count(), CSG_Table::Get_Field_Count(), CSG_Parameter_List::Get_Item(), CSG_Parameter_List::Get_Item_Count(), CSG_Parameter_Range::Get_Max(), CSG_Parameter_Range::Get_Min(), CSG_Parameters::Get_Parameter(), CSG_Table::Get_Record(), CSG_Parameter_Choices::Get_Selection_Count(), CSG_Parameter_Choices::Get_Selection_Index(), Get_Type(), CSG_Table::is_Compatible(), CSG_Grid_System::is_Equal(), is_Value_Equal(), PARAMETER_TYPE_Bool, PARAMETER_TYPE_Choice, PARAMETER_TYPE_Choices, PARAMETER_TYPE_Color, PARAMETER_TYPE_Colors, PARAMETER_TYPE_Data_Type, PARAMETER_TYPE_DataObject_Output, PARAMETER_TYPE_Date, PARAMETER_TYPE_Degree, PARAMETER_TYPE_Double, PARAMETER_TYPE_FilePath, PARAMETER_TYPE_FixedTable, PARAMETER_TYPE_Font, PARAMETER_TYPE_Grid, PARAMETER_TYPE_Grid_List, PARAMETER_TYPE_Grid_System, PARAMETER_TYPE_Grids, PARAMETER_TYPE_Grids_List, PARAMETER_TYPE_Int, PARAMETER_TYPE_Node, PARAMETER_TYPE_Parameters, PARAMETER_TYPE_PointCloud, PARAMETER_TYPE_PointCloud_List, PARAMETER_TYPE_Range, PARAMETER_TYPE_Shapes, PARAMETER_TYPE_Shapes_List, PARAMETER_TYPE_String, PARAMETER_TYPE_Table, PARAMETER_TYPE_Table_Field, PARAMETER_TYPE_Table_Fields, PARAMETER_TYPE_Table_List, PARAMETER_TYPE_Text, PARAMETER_TYPE_TIN, PARAMETER_TYPE_TIN_List, and SG_STR_CMP.

Referenced by is_Value_Equal().

◆ Restore_Default()

bool CSG_Parameter::Restore_Default ( void )
virtual

Reimplemented in CSG_Parameter_Font, CSG_Parameter_Parameters, and CSG_Parameter_Range.

Definition at line 972 of file parameter.cpp.

References Set_Value().

◆ Serialize()

bool CSG_Parameter::Serialize ( CSG_MetaData & MetaData,
bool bSave )

Definition at line 1222 of file parameter.cpp.

References _Serialize(), _Set_String(), CSG_MetaData::Add_Child(), CSG_MetaData::Add_Property(), CSG_MetaData::Cmp_Property(), Get_Identifier(), Get_Name(), Get_Parameters(), Get_Type(), Get_Type_Identifier(), is_DataObject(), is_DataObject_List(), is_Information(), is_Option(), PARAMETER_TYPE_Node, and PARAMETER_TYPE_Undefined.

Referenced by CSG_Parameters::Load(), and CSG_Parameters::Set_History().

◆ Set_Children_Enabled()

bool CSG_Parameter::Set_Children_Enabled ( bool bEnabled = true)

Definition at line 243 of file parameter.cpp.

References Get_Child(), Get_Children_Count(), and Set_Enabled().

◆ Set_Collapsed()

bool CSG_Parameter::Set_Collapsed ( bool bOn = true)

Definition at line 140 of file parameter.cpp.

References is_Collapsed(), and PARAMETER_GUI_COLLAPSED.

Referenced by Assign(), CSG_Parameter_Degree::CSG_Parameter_Degree(), CSG_Parameter_Range::CSG_Parameter_Range(), and Get_Type().

◆ Set_Default() [1/3]

bool CSG_Parameter::Set_Default ( const CSG_String & Value)

Definition at line 952 of file parameter.cpp.

◆ Set_Default() [2/3]

bool CSG_Parameter::Set_Default ( double Value)

Definition at line 944 of file parameter.cpp.

◆ Set_Default() [3/3]

bool CSG_Parameter::Set_Default ( int Value)

Definition at line 936 of file parameter.cpp.

Referenced by CSG_Parameters::Add_Choice(), CSG_Parameters::Add_FilePath(), CSG_Parameters::Add_Font(), CSG_Parameters::Add_Grid_Resampling(), and CSG_Parameter_Data_Type::Set_Data_Types().

◆ Set_Description()

bool CSG_Parameter::Set_Description ( const CSG_String & Description)

Definition at line 610 of file parameter.cpp.

Referenced by Get_Type().

◆ Set_Enabled()

bool CSG_Parameter::Set_Enabled ( bool bEnabled = true)

Definition at line 211 of file parameter.cpp.

Referenced by CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Table_Field::_Set_Value(), Get_Type(), Set_Children_Enabled(), and CSG_Parameters::Set_Enabled().

◆ Set_Name()

bool CSG_Parameter::Set_Name ( const CSG_String & Name)

Definition at line 597 of file parameter.cpp.

Referenced by Get_Type().

◆ Set_UseInCMD()

void CSG_Parameter::Set_UseInCMD ( bool bOn = false)

Definition at line 168 of file parameter.cpp.

References PARAMETER_NOT_FOR_CMD.

◆ Set_UseInGUI()

void CSG_Parameter::Set_UseInGUI ( bool bOn = false)

Definition at line 155 of file parameter.cpp.

References PARAMETER_NOT_FOR_GUI.

Referenced by CSG_Parameters_CRSPicker::Create().

◆ Set_Value() [1/8]

bool CSG_Parameter::Set_Value ( const char * Value)
virtual

Definition at line 860 of file parameter.cpp.

References Set_Value().

◆ Set_Value() [2/8]

bool CSG_Parameter::Set_Value ( const CSG_String & Value)
virtual

Definition at line 862 of file parameter.cpp.

References _Set_Value(), has_Changed(), SG_PARAMETER_DATA_SET_CHANGED, and SG_PARAMETER_DATA_SET_FALSE.

◆ Set_Value() [3/8]

bool CSG_Parameter::Set_Value ( const wchar_t * Value)
virtual

Definition at line 861 of file parameter.cpp.

References Set_Value().

◆ Set_Value() [4/8]

bool CSG_Parameter::Set_Value ( CSG_Grid_Resampling Value)
virtual

Definition at line 845 of file parameter.cpp.

References _Set_Value(), has_Changed(), SG_PARAMETER_DATA_SET_CHANGED, and SG_PARAMETER_DATA_SET_FALSE.

◆ Set_Value() [5/8]

bool CSG_Parameter::Set_Value ( CSG_Parameter * Value)
virtual

Definition at line 892 of file parameter.cpp.

References asInt(), Assign(), CSG_Parameter(), Get_Type(), PARAMETER_TYPE_Choice, PARAMETER_TYPE_Data_Type, and Set_Value().

◆ Set_Value() [6/8]

bool CSG_Parameter::Set_Value ( double Value)
virtual

Definition at line 830 of file parameter.cpp.

References _Set_Value(), has_Changed(), SG_PARAMETER_DATA_SET_CHANGED, and SG_PARAMETER_DATA_SET_FALSE.

◆ Set_Value() [7/8]

bool CSG_Parameter::Set_Value ( int Value)
virtual

Definition at line 815 of file parameter.cpp.

References _Set_Value(), has_Changed(), SG_PARAMETER_DATA_SET_CHANGED, and SG_PARAMETER_DATA_SET_FALSE.

Referenced by CSG_Parameter_Grid::_Set_Value(), CSG_Parameter_Grid_System::_Set_Value(), CSG_Parameter_PointCloud::_Set_Value(), CSG_Parameter_Shapes::_Set_Value(), CSG_Parameter_Table::_Set_Value(), CSG_Parameter_TIN::_Set_Value(), CSG_Parameters::Add_Choice(), CSG_Parameters::Add_FilePath(), CSG_Parameters::Add_Font(), CSG_Parameters::Add_Grid_Resampling(), CSG_Parameter_Grid_List::Add_Item(), CSG_Parameter_Grids_List::Add_Item(), Check(), CSG_Parameters_Grid_Target::Get_Grid(), CSG_Parameters_Grid_Target::Get_Grids(), Restore_Default(), CSG_Parameters::Serialize_Compatibility(), CSG_Parameter_Data_Type::Set_Data_Type(), CSG_Parameter_Data_Type::Set_Data_Types(), CSG_Parameters::Set_Parameter(), CSG_Parameters::Set_Parameter(), CSG_Parameters::Set_Parameter(), CSG_Parameters::Set_Parameter(), CSG_Parameters::Set_Parameter(), Set_Value(), Set_Value(), Set_Value(), CSG_Parameter_Bool::Toggle_Value(), and CSG_Parameter_Choice::Toggle_Value().

◆ Set_Value() [8/8]

bool CSG_Parameter::Set_Value ( void * Value)
virtual

Definition at line 877 of file parameter.cpp.

References _Set_Value(), has_Changed(), SG_PARAMETER_DATA_SET_CHANGED, and SG_PARAMETER_DATA_SET_FALSE.

◆ Toggle_Value()

bool CSG_Parameter::Toggle_Value ( void )
virtual

Reimplemented in CSG_Parameter_Bool, and CSG_Parameter_Choice.

Definition at line 911 of file parameter.cpp.

◆ CSG_Parameters

friend class CSG_Parameters
friend

Definition at line 332 of file parameters.h.

References CSG_Parameter(), and CSG_Parameters.

Referenced by asParameters(), CSG_Parameter(), CSG_Parameters, and Get_Parameters().

Member Data Documentation

◆ m_String

CSG_String CSG_Parameter::m_String
protected

Definition at line 337 of file parameters.h.

Referenced by CSG_Parameter_Font::_asPointer(), CSG_Parameter_Font::_Assign(), CSG_Parameter_String::_Assign(), _asString(), CSG_Parameter_Font::_Serialize(), CSG_Parameter_String::_Serialize(), CSG_Parameter_Table_Fields::_Serialize(), CSG_Parameter_Bool::_Set_String(), CSG_Parameter_Choice::_Set_String(), CSG_Parameter_Choices::_Set_String(), CSG_Parameter_Colors::_Set_String(), CSG_Parameter_Data_Object::_Set_String(), CSG_Parameter_Date::_Set_String(), CSG_Parameter_Degree::_Set_String(), CSG_Parameter_Double::_Set_String(), CSG_Parameter_Fixed_Table::_Set_String(), CSG_Parameter_Grid_System::_Set_String(), CSG_Parameter_Int::_Set_String(), CSG_Parameter_List::_Set_String(), CSG_Parameter_Parameters::_Set_String(), CSG_Parameter_Range::_Set_String(), CSG_Parameter_Table_Field::_Set_String(), CSG_Parameter_Font::_Set_Value(), CSG_Parameter_String::_Set_Value(), CSG_Parameter_Table_Fields::_Set_Value(), CSG_Parameter_File_Name::Get_FilePaths(), CSG_Parameter_String::is_Valid(), and CSG_Parameter_Font::Restore_Default().

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