CSG_Parameter_File_Name Class Reference

#include <parameters.h>

Inheritance diagram for CSG_Parameter_File_Name:

Public Member Functions
virtual TSG_Parameter_Type	Get_Type (void) const
void	Set_Filter (const SG_Char *Filter)
const SG_Char *	Get_Filter (void) const
void	Set_Flag_Save (bool bFlag)
bool	is_Save (void) const
void	Set_Flag_Multiple (bool bFlag)
bool	is_Multiple (void) const
void	Set_Flag_Directory (bool bFlag)
bool	is_Directory (void) const
bool	Get_FilePaths (CSG_Strings &FilePaths) const
Public Member Functions inherited from CSG_Parameter_String
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	Set_Collapsed (bool bOn=true)
bool	is_Collapsed (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_File_Name (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)
Protected Member Functions inherited from 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)
virtual int	_Set_Value (const CSG_String &Value)
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 (CSG_Grid_Resampling 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_bSave
bool	m_bMultiple
bool	m_bDirectory
CSG_String	m_Filter
Protected Attributes inherited from CSG_Parameter_String
bool	m_bPassword
Protected Attributes inherited from CSG_Parameter
CSG_String	m_String

Friends
class	CSG_Parameters

Detailed Description

Definition at line 861 of file parameters.h.

Constructor & Destructor Documentation

CSG_Parameter_File_Name()

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

protected

Definition at line 1563 of file parameter_data.cpp.

References _TL, CSG_Parameter_String::CSG_Parameter_String(), CSG_Parameters, m_bDirectory, m_bMultiple, m_bSave, and m_Filter.

Referenced by _Assign().

Member Function Documentation

_Assign()

bool CSG_Parameter_File_Name::_Assign ( CSG_Parameter * pSource )

protectedvirtual

Reimplemented from CSG_Parameter_String.

Definition at line 1639 of file parameter_data.cpp.

References CSG_Parameter_String::_Assign(), CSG_Parameter::asFilePath(), CSG_Parameter_File_Name(), m_bDirectory, m_bMultiple, m_bSave, m_Filter, and Set_Filter().

Get_FilePaths()

bool CSG_Parameter_File_Name::Get_FilePaths

(

CSG_Strings &

FilePaths

)

const

Definition at line 1608 of file parameter_data.cpp.

References CSG_Strings::Add(), CSG_String::AfterFirst(), CSG_String::BeforeFirst(), CSG_Strings::Clear(), CSG_Strings::Get_Count(), CSG_String::Length(), m_bMultiple, and CSG_Parameter::m_String.

Get_Filter()

const SG_Char * CSG_Parameter_File_Name::Get_Filter

(

void

)

const

Definition at line 1586 of file parameter_data.cpp.

References m_Filter, and SG_Char.

Get_Type()

virtual TSG_Parameter_Type CSG_Parameter_File_Name::Get_Type ( void ) const

inlinevirtual

Reimplemented from CSG_Parameter_String.

Definition at line 865 of file parameters.h.

References PARAMETER_TYPE_FilePath.

is_Directory()

bool CSG_Parameter_File_Name::is_Directory ( void ) const

inline

Definition at line 877 of file parameters.h.

References m_bDirectory.

is_Multiple()

bool CSG_Parameter_File_Name::is_Multiple ( void ) const

inline

Definition at line 874 of file parameters.h.

References m_bMultiple.

is_Save()

bool CSG_Parameter_File_Name::is_Save ( void ) const

inline

Definition at line 871 of file parameters.h.

References m_bSave.

Set_Filter()

void CSG_Parameter_File_Name::Set_Filter

(

const SG_Char *

Filter

)

Definition at line 1574 of file parameter_data.cpp.

References _TL, m_Filter, and SG_Char.

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

Set_Flag_Directory()

void CSG_Parameter_File_Name::Set_Flag_Directory

(

bool

bFlag

)

Definition at line 1602 of file parameter_data.cpp.

References m_bDirectory.

Referenced by CSG_Parameters::Add_FilePath().

Set_Flag_Multiple()

void CSG_Parameter_File_Name::Set_Flag_Multiple

(

bool

bFlag

)

Definition at line 1597 of file parameter_data.cpp.

References m_bMultiple.

Referenced by CSG_Parameters::Add_FilePath().

Set_Flag_Save()

void CSG_Parameter_File_Name::Set_Flag_Save

(

bool

bFlag

)

Definition at line 1592 of file parameter_data.cpp.

References m_bSave.

Referenced by CSG_Parameters::Add_FilePath().

Friends And Related Symbol Documentation

CSG_Parameters

friend class CSG_Parameters

friend

Definition at line 894 of file parameters.h.

References CSG_Parameters.

Referenced by CSG_Parameter_File_Name(), and CSG_Parameters.

Member Data Documentation

m_bDirectory

bool CSG_Parameter_File_Name::m_bDirectory

protected

Definition at line 886 of file parameters.h.

Referenced by _Assign(), CSG_Parameter_File_Name(), is_Directory(), and Set_Flag_Directory().

m_bMultiple

bool CSG_Parameter_File_Name::m_bMultiple

protected

Definition at line 886 of file parameters.h.

Referenced by _Assign(), CSG_Parameter_File_Name(), Get_FilePaths(), is_Multiple(), and Set_Flag_Multiple().

m_bSave

bool CSG_Parameter_File_Name::m_bSave

protected

Definition at line 886 of file parameters.h.

Referenced by _Assign(), CSG_Parameter_File_Name(), is_Save(), and Set_Flag_Save().

m_Filter

CSG_String CSG_Parameter_File_Name::m_Filter

protected

Definition at line 888 of file parameters.h.

Referenced by _Assign(), CSG_Parameter_File_Name(), Get_Filter(), and Set_Filter().

---

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

• parameters.h
• parameter_data.cpp