#include <parameters.h>

Inheritance diagram for CSG_Parameter_Choices:

Public Member Functions
virtual TSG_Parameter_Type	Get_Type (void) const

void	Set_Items (const CSG_String &Items)

void	Set_Items (const CSG_Strings &Items)

CSG_String	Get_Items (void) const

void	Del_Items (void)

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

int	Get_Item_Count (void) const

const CSG_String &	Get_Item (int i) const

const CSG_String &	Get_Item_Data (int i) const

int	Get_Selection_Count (void) const

const CSG_String &	Get_Selection (int i) const

const CSG_String &	Get_Selection_Data (int i) const

int	Get_Selection_Index (int i) const

bool	is_Selected (int Index)

bool	Select (int Index, bool bSelect=true)

bool	Clr_Selection (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

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_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_Choices (CSG_Parameters pOwner, CSG_Parameter pParent, const CSG_String &ID, const CSG_String &Name, const CSG_String &Description, int Constraint)

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_Strings	m_Items [2]

CSG_Array_Int	m_Selection

Protected Attributes inherited from CSG_Parameter
CSG_String	m_String

Friends
class	CSG_Parameters

Detailed Description

Definition at line 747 of file parameters.h.

Constructor & Destructor Documentation

◆ CSG_Parameter_Choices()

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

protected

Definition at line 1265 of file parameter_data.cpp.

Member Function Documentation

◆ _Assign()

bool CSG_Parameter_Choices::_Assign ( CSG_Parameter * pSource )

protectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 1414 of file parameter_data.cpp.

References CSG_Parameter::asChoices(), m_Items, and m_Selection.

◆ _Serialize()

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

protectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 1425 of file parameter_data.cpp.

References _Set_Value(), CSG_Parameter::asString(), CSG_MetaData::Get_Content(), and CSG_MetaData::Set_Content().

◆ _Set_String()

void CSG_Parameter_Choices::_Set_String ( void )

protectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 1292 of file parameter_data.cpp.

References CSG_String::Clear(), CSG_String::Format(), CSG_Array_Int::Get_uSize(), m_Selection, and CSG_Parameter::m_String.

◆ _Set_Value()

int CSG_Parameter_Choices::_Set_Value ( const CSG_String & Value )

protectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 1272 of file parameter_data.cpp.

References CSG_String::asInt(), CSG_Array_Int::Destroy(), CSG_String_Tokenizer::Get_Next_Token(), CSG_String_Tokenizer::Has_More_Tokens(), m_Selection, Select(), and SG_PARAMETER_DATA_SET_CHANGED.

Referenced by _Serialize().

◆ Add_Item()

void CSG_Parameter_Choices::Add_Item	(	const CSG_String &	Item,
		const CSG_String &	Data = `""`
	)

Definition at line 1354 of file parameter_data.cpp.

References m_Items.

Referenced by Set_Items().

◆ Clr_Selection()

bool CSG_Parameter_Choices::Clr_Selection ( void )

Definition at line 1406 of file parameter_data.cpp.

References CSG_Array_Int::Destroy(), and m_Selection.

◆ Del_Items()

void CSG_Parameter_Choices::Del_Items ( void )

Definition at line 1345 of file parameter_data.cpp.

References CSG_Strings::Clear(), CSG_Array_Int::Destroy(), m_Items, and m_Selection.

Referenced by Set_Items().

◆ Get_Item()

const CSG_String& CSG_Parameter_Choices::Get_Item ( int i ) const

inline

Definition at line 760 of file parameters.h.

Referenced by CSG_Parameter::is_Compatible(), and SG_XML_Add_Parameter().

◆ Get_Item_Count()

int CSG_Parameter_Choices::Get_Item_Count ( void ) const

inline

Definition at line 759 of file parameters.h.

Referenced by CSG_Parameter::Get_Description(), CSG_Parameter::is_Compatible(), and Select().

◆ Get_Item_Data()

const CSG_String& CSG_Parameter_Choices::Get_Item_Data ( int i ) const

inline

Definition at line 761 of file parameters.h.

◆ Get_Items()

CSG_String CSG_Parameter_Choices::Get_Items ( void ) const

Definition at line 1327 of file parameter_data.cpp.

References CSG_Strings::Get_Count(), and m_Items.

◆ Get_Selection()

const CSG_String& CSG_Parameter_Choices::Get_Selection ( int i ) const

inline

Definition at line 764 of file parameters.h.

◆ Get_Selection_Count()

int CSG_Parameter_Choices::Get_Selection_Count ( void ) const

inline

Definition at line 763 of file parameters.h.

Referenced by CSG_Parameter::is_Value_Equal().

◆ Get_Selection_Data()

const CSG_String& CSG_Parameter_Choices::Get_Selection_Data ( int i ) const

inline

Definition at line 765 of file parameters.h.

◆ Get_Selection_Index()

int CSG_Parameter_Choices::Get_Selection_Index ( int i ) const

inline

Definition at line 766 of file parameters.h.

Referenced by CSG_Parameter::is_Value_Equal().

◆ Get_Type()

virtual TSG_Parameter_Type CSG_Parameter_Choices::Get_Type ( void ) const

inlinevirtual

Implements CSG_Parameter.

Definition at line 751 of file parameters.h.

References PARAMETER_TYPE_Choices.

◆ is_Selected()

bool CSG_Parameter_Choices::is_Selected ( int Index )

Definition at line 1361 of file parameter_data.cpp.

References CSG_Array_Int::Get_uSize(), and m_Selection.

Referenced by Select().

◆ Select()

bool CSG_Parameter_Choices::Select	(	int	Index,
		bool	bSelect = `true`
	)

Definition at line 1375 of file parameter_data.cpp.

References CSG_Array_Int::Dec_Array(), Get_Item_Count(), CSG_Array_Int::Get_uSize(), is_Selected(), and m_Selection.

Referenced by _Set_Value().

◆ Set_Items() [1/2]

void CSG_Parameter_Choices::Set_Items ( const CSG_String & Items )

Definition at line 1303 of file parameter_data.cpp.

References Add_Item(), Del_Items(), CSG_String_Tokenizer::Get_Next_Token(), and CSG_String_Tokenizer::Has_More_Tokens().

Referenced by CSG_Parameters::Add_Choices().

◆ Set_Items() [2/2]

void CSG_Parameter_Choices::Set_Items ( const CSG_Strings & Items )

Definition at line 1316 of file parameter_data.cpp.

References Add_Item(), Del_Items(), and CSG_Strings::Get_Count().

Friends And Related Function Documentation

◆ CSG_Parameters

friend class CSG_Parameters

friend

Definition at line 790 of file parameters.h.

Member Data Documentation

◆ m_Items

CSG_Strings CSG_Parameter_Choices::m_Items[2]

protected

Definition at line 777 of file parameters.h.

Referenced by _Assign(), Add_Item(), Del_Items(), and Get_Items().

◆ m_Selection

CSG_Array_Int CSG_Parameter_Choices::m_Selection

protected

Definition at line 779 of file parameters.h.

Referenced by _Assign(), _Set_String(), _Set_Value(), Clr_Selection(), Del_Items(), is_Selected(), and Select().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CSG_Parameter_Choices()

Member Function Documentation

◆ _Assign()

◆ _Serialize()

◆ _Set_String()

◆ _Set_Value()

◆ Add_Item()

◆ Clr_Selection()

◆ Del_Items()

◆ Get_Item()

◆ Get_Item_Count()

◆ Get_Item_Data()

◆ Get_Items()

◆ Get_Selection()

◆ Get_Selection_Count()

◆ Get_Selection_Data()

◆ Get_Selection_Index()

◆ Get_Type()

◆ is_Selected()

◆ Select()

◆ Set_Items() [1/2]

◆ Set_Items() [2/2]

Friends And Related Function Documentation

◆ CSG_Parameters

Member Data Documentation

◆ m_Items

◆ m_Selection