#include <parameters.h>

Inheritance diagram for CSG_Parameter_Data_Type:

Public Member Functions
virtual TSG_Parameter_Type	Get_Type (void) const

bool	Set_Data_Types (int Data_Types, TSG_Data_Type Default=SG_DATATYPE_Undefined, const CSG_String &User="")

bool	Set_Data_Type (TSG_Data_Type Value)

TSG_Data_Type	Get_Data_Type (TSG_Data_Type Default=SG_DATATYPE_Undefined) const

Public Member Functions inherited from CSG_Parameter_Choice
virtual bool	is_Default (void) const

virtual bool	Toggle_Value (void)

bool	Del_Items (void)

bool	Add_Item (const CSG_String &Item, const CSG_String &Data="")

bool	Set_Items (const SG_Char *String)

CSG_String	Get_Items (void) const

const SG_Char *	Get_Item (int Index) const

CSG_String	Get_Item_Data (int Index) const

CSG_String	Get_Data (void) const

bool	Get_Data (CSG_String &Value) const

bool	Get_Data (int &Value) const

bool	Get_Data (double &Value) const

int	Get_Count (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)

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)

Protected Member Functions
	CSG_Parameter_Data_Type (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)

virtual bool	_Serialize (CSG_MetaData &Entry, bool bSave)

Protected Member Functions inherited from CSG_Parameter_Choice
	CSG_Parameter_Choice (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

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

Friends
class	CSG_Parameters

Additional Inherited Members
Protected Attributes inherited from CSG_Parameter_Choice
int	m_Value

CSG_Strings	m_Items

CSG_Strings	m_Data

Protected Attributes inherited from CSG_Parameter
CSG_String	m_String

Detailed Description

Definition at line 717 of file parameters.h.

Constructor & Destructor Documentation

◆ CSG_Parameter_Data_Type()

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

protected

Definition at line 1133 of file parameter_data.cpp.

Member Function Documentation

◆ _Assign()

bool CSG_Parameter_Data_Type::_Assign ( CSG_Parameter * pSource )

protectedvirtual

Reimplemented from CSG_Parameter_Choice.

Definition at line 1246 of file parameter_data.cpp.

References CSG_Parameter_Choice::_Assign().

◆ _Serialize()

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

protectedvirtual

Reimplemented from CSG_Parameter_Choice.

Definition at line 1252 of file parameter_data.cpp.

References CSG_Parameter_Choice::_Serialize().

◆ Get_Data_Type()

TSG_Data_Type CSG_Parameter_Data_Type::Get_Data_Type ( TSG_Data_Type Default = SG_DATATYPE_Undefined ) const

This function returns the selected data type. If an additional 'user' option has been added and is selected, the data type returned is the one given as 'Default' argument. This is useful e.g. if you want to return a data type that comes from an input data set.

Definition at line 1238 of file parameter_data.cpp.

References CSG_Parameter_Choice::Get_Data(), SG_Data_Type_Get_Type(), and SG_DATATYPE_Undefined.

◆ Get_Type()

virtual TSG_Parameter_Type CSG_Parameter_Data_Type::Get_Type ( void ) const

inlinevirtual

Reimplemented from CSG_Parameter_Choice.

Definition at line 721 of file parameters.h.

References PARAMETER_TYPE_Data_Type.

◆ Set_Data_Type()

bool CSG_Parameter_Data_Type::Set_Data_Type ( TSG_Data_Type Value )

Select a data type from the choices list after it has been initialized. Useful e.g. when adjusting a default data type in CSG_Tool::On_Parameters_Changed() to a changed input data selection.

Definition at line 1216 of file parameter_data.cpp.

References CSG_Parameter_Choice::Get_Count(), CSG_Parameter_Choice::Get_Item_Data(), CSG_Parameter::Set_Value(), and SG_Data_Type_Get_Type().

◆ Set_Data_Types()

bool CSG_Parameter_Data_Type::Set_Data_Types	(	int	Data_Types,
		TSG_Data_Type	Default = `SG_DATATYPE_Undefined`,
		const CSG_String &	User = `""`
	)

This function initializes the data types available for selection. The Data_Types argument expects a combination of data type flags as defined in <api_core.h>, e.g. SG_DATATYPES_Integer or SG_DATATYPES_Numeric. You can add an additional choice with the User argument, e.g. to offer a type related to an selected input data set.

Definition at line 1149 of file parameter_data.cpp.

References CSG_Parameter_Choice::Add_Item(), ADD_TYPE, CSG_Parameter_Choice::Get_Count(), CSG_String::is_Empty(), CSG_Parameter::Set_Default(), CSG_Parameter::Set_Value(), SG_Data_Type_Get_Identifier(), SG_DATATYPE_Binary, SG_DATATYPE_Bit, SG_DATATYPE_Byte, SG_DATATYPE_Char, SG_DATATYPE_Color, SG_DATATYPE_Date, SG_DATATYPE_Double, SG_DATATYPE_DWord, SG_DATATYPE_Float, SG_DATATYPE_Int, SG_DATATYPE_Long, SG_DATATYPE_Short, SG_DATATYPE_String, SG_DATATYPE_ULong, SG_DATATYPE_Undefined, SG_DATATYPE_Word, SG_DATATYPES_Bit, SG_DATATYPES_Integer, SG_DATATYPES_Numeric, SG_DATATYPES_Standard, SG_DATATYPES_Table, and SG_DATATYPES_Undefined.

Referenced by CSG_Parameters::Add_Data_Type().

Friends And Related Function Documentation

◆ CSG_Parameters

friend class CSG_Parameters

friend

Definition at line 738 of file parameters.h.

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

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CSG_Parameter_Data_Type()

Member Function Documentation

◆ _Assign()

◆ _Serialize()

◆ Get_Data_Type()

◆ Get_Type()

◆ Set_Data_Type()

◆ Set_Data_Types()

Friends And Related Function Documentation

◆ CSG_Parameters