#include <parameters.h>

Inheritance diagram for CSG_Parameter_String:

Public Member Functions
virtual TSG_Parameter_Type	Get_Type (void) const

virtual bool	is_Valid (void) const

void	Set_Password (bool bOn)

bool	is_Password (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	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_String (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 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 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

Protected Attributes
bool	m_bPassword

Protected Attributes inherited from CSG_Parameter
CSG_String	m_String

Friends
class	CSG_Parameters

Detailed Description

Definition at line 799 of file parameters.h.

Constructor & Destructor Documentation

◆ CSG_Parameter_String()

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

protected

Definition at line 1447 of file parameter_data.cpp.

References m_bPassword.

Member Function Documentation

◆ _Assign()

bool CSG_Parameter_String::_Assign ( CSG_Parameter * pSource )

protectedvirtual

Reimplemented from CSG_Parameter.

Reimplemented in CSG_Parameter_File_Name.

Definition at line 1485 of file parameter_data.cpp.

References m_bPassword, and CSG_Parameter::m_String.

Referenced by CSG_Parameter_File_Name::_Assign().

◆ _Serialize()

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

protectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 1494 of file parameter_data.cpp.

References CSG_MetaData::Get_Content(), CSG_Parameter::m_String, and CSG_MetaData::Set_Content().

◆ _Set_Value()

int CSG_Parameter_String::_Set_Value ( const CSG_String & Value )

protectedvirtual

Reimplemented from CSG_Parameter.

Definition at line 1472 of file parameter_data.cpp.

References CSG_String::Cmp(), CSG_Parameter::m_String, SG_PARAMETER_DATA_SET_CHANGED, and SG_PARAMETER_DATA_SET_TRUE.

◆ Get_Type()

virtual TSG_Parameter_Type CSG_Parameter_String::Get_Type ( void ) const

inlinevirtual

Implements CSG_Parameter.

Reimplemented in CSG_Parameter_File_Name, and CSG_Parameter_Text.

Definition at line 803 of file parameters.h.

References PARAMETER_TYPE_String.

◆ is_Password()

bool CSG_Parameter_String::is_Password ( void ) const

Definition at line 1466 of file parameter_data.cpp.

References m_bPassword.

◆ is_Valid()

bool CSG_Parameter_String::is_Valid ( void ) const

virtual

Reimplemented from CSG_Parameter.

Definition at line 1454 of file parameter_data.cpp.

References CSG_String::is_Empty(), and CSG_Parameter::m_String.

◆ Set_Password()

void CSG_Parameter_String::Set_Password ( bool bOn )

Definition at line 1460 of file parameter_data.cpp.

References m_bPassword.

Friends And Related Function Documentation

◆ CSG_Parameters

friend class CSG_Parameters

friend

Definition at line 824 of file parameters.h.

Member Data Documentation

◆ m_bPassword

bool CSG_Parameter_String::m_bPassword

protected

Definition at line 815 of file parameters.h.

Referenced by _Assign(), CSG_Parameter_String(), is_Password(), and Set_Password().

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_String()

Member Function Documentation

◆ _Assign()

◆ _Serialize()

◆ _Set_Value()

◆ Get_Type()

◆ is_Password()

◆ is_Valid()

◆ Set_Password()

Friends And Related Function Documentation

◆ CSG_Parameters

Member Data Documentation

◆ m_bPassword