wxGISGPParameter Class Reference

A Geoprocessing tools parameter class. More...

#include <gpparam.h>

Inheritance diagram for wxGISGPParameter:

Collaboration diagram for wxGISGPParameter:

Public Member Functions
	wxGISGPParameter (const wxString &sName, const wxString &sDisplayName, wxGISEnumGPParameterType eType, wxGISEnumGPParameterDataType eDataType)
virtual bool	GetAltered (void) const
virtual void	SetAltered (bool bAltered)
virtual bool	GetHasBeenValidated (void) const
virtual void	SetHasBeenValidated (bool bHasBeenValidated)
virtual bool	IsValid (void) const
virtual void	SetValid (bool bIsValid)
virtual wxString	GetName (void) const
virtual void	SetName (const wxString &sName)
virtual wxString	GetDisplayName (void) const
virtual void	SetDisplayName (const wxString &sDisplayName)
virtual wxGISEnumGPParameterDataType	GetDataType (void) const
virtual void	SetDataType (wxGISEnumGPParameterDataType nType)
virtual wxGISEnumGPParameterDirection	GetDirection (void) const
virtual void	SetDirection (wxGISEnumGPParameterDirection nDirection)
virtual wxGISEnumGPParameterType	GetParameterType (void) const
virtual void	SetParameterType (wxGISEnumGPParameterType nType)
virtual wxVariant	GetValue (void) const
virtual void	SetValue (const wxVariant &Val)
virtual wxGISGPValueDomain *	GetDomain (void) const
virtual void	SetDomain (wxGISGPValueDomain *pDomain)
virtual wxString	GetMessage (void) const
virtual wxGISEnumGPMessageType	GetMessageType (void) const
virtual void	SetMessage (wxGISEnumGPMessageType nType=wxGISEnumGPMessageUnknown, const wxString &sMsg=wxEmptyString)
virtual void	AddDependency (const wxString &sParamName)
virtual wxArrayString	GetDependences (void) const
virtual wxString	GetAsString (void) const
	Serialize parameter to string. More...
virtual bool	SetFromString (wxString &sParam)
	Serialize parameter from string. More...
virtual int	GetSelDomainValue (void) const
virtual void	SetSelDomainValue (int nNewSelection)
virtual void	OnValueAdded (const wxVariant &Value, const wxString &sName)
virtual void	OnCleared (void)
Public Member Functions inherited from wxGISConnectionPointContainer
virtual long	Advise (wxEvtHandler *pEvtHandler)
virtual void	Unadvise (long nCookie)
Public Member Functions inherited from IGISGPDomainParent
virtual	~IGISGPDomainParent (void)

Protected Member Functions
virtual void	SetId (size_t nId)
virtual size_t	GetId (void) const
Protected Member Functions inherited from wxGISConnectionPointContainer
virtual void	AddEvent (const wxEvent &event)
virtual void	PostEvent (wxEvent *event)

Protected Attributes
bool	m_bAltered
bool	m_bHasBeenValidated
bool	m_bIsValid
wxString	m_sName
wxString	m_sDisplayName
wxGISEnumGPParameterDataType	m_DataType
wxGISEnumGPParameterDirection	m_Direction
wxGISEnumGPParameterType	m_ParameterType
wxVariant	m_Value
wxGISGPValueDomain *	m_pDomain
wxString	m_sMessage
wxGISEnumGPMessageType	m_nMsgType
int	m_nSelection
wxArrayString	m_saDependencies
size_t	m_nId
Protected Attributes inherited from wxGISConnectionPointContainer
wxVector< wxEvtHandler * >	m_pPointsArray
wxCriticalSection	m_CritSectEvt

Friends
class	wxGISGPParameterArray

Detailed Description

A Geoprocessing tools parameter class.

Member Function Documentation

wxString wxGISGPParameter::GetAsString ( void  ) const

virtual

Serialize parameter to string.

Returns

The string representation of parameter

Reimplemented in wxGISGPMultiParameter.

void wxGISGPParameter::OnCleared ( void  )

virtual

Fires then value domain cleared

Implements IGISGPDomainParent.

void wxGISGPParameter::OnValueAdded ( const wxVariant &  Value, const wxString &  sName  )

virtual

Fires then value added to the domain

Parameters

Value	The added value to the domain
sName	The name for the added value. This name will be used in lists or choices for indicating this value.

Implements IGISGPDomainParent.

bool wxGISGPParameter::SetFromString ( wxString &  sParam )

virtual

Serialize parameter from string.

Parameters

sParam

The string representation of parameter

Reimplemented in wxGISGPMultiParameter.

Here is the caller graph for this function:

---

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

• /home/bishop/work/projects/nextgismanager/include/wxgis/geoprocessing/gpparam.h
• /home/bishop/work/projects/nextgismanager/src/geoprocessing/gpparam.cpp