wxGISGPTool Class Reference

#include <gptool.h>

Inheritance diagram for wxGISGPTool:

Collaboration diagram for wxGISGPTool:

Public Member Functions
	wxGISGPTool (void)
virtual	~wxGISGPTool (void)
virtual const wxString	GetDisplayName (void)=0
virtual const wxString	GetName (void)=0
virtual const wxString	GetCategory (void)=0
virtual bool	Execute (ITrackCancel *pTrackCancel)=0
virtual bool	Validate (void)=0
virtual GPParameters	GetParameterInfo (void)=0
virtual void	SetCatalog (IGxCatalog *pCatalog)
virtual IGxCatalog *const	GetCatalog (void)
virtual const wxString	GetAsString (void)
virtual bool	SetFromString (const wxString &sParams)
virtual void	Copy (IGPTool *const pTool)

Protected Attributes
GPParameters	m_paParam
IGxCatalog *	m_pCatalog

Detailed Description

The base class for geoprocessing tools. This class implements common functions.

Library:  page_libs_wxgiswxgisgp

Constructor & Destructor Documentation

wxGISGPTool::wxGISGPTool

(

void

)

Constructor

wxGISGPTool::~wxGISGPTool ( void  )

virtual

Destructor

Member Function Documentation

void wxGISGPTool::Copy ( IGPTool *const  pTool )

virtual

Copy parameters from input tool to current

Parameters

pTool

The tool pointer there parameters should be captured

Here is the call graph for this function:

virtual bool wxGISGPTool::Execute ( ITrackCancel *  pTrackCancel )

pure virtual

This function call from task manager than task is started.

Parameters

pTrackCancel

The pointer to the ITrackCancel which get status meesages, done percent and indicating, that tool should stop execution than user cancel it

Returns

true on success and false if failed

Implemented in wxGISGPOrthoCorrectTool, wxGISGPShapeToTextTool, wxGISGPSubRasterByVectorTool, wxGISGPCompStatTool, wxGISGPCreateOverviewsTool, wxGISGPExportTool, wxGISGPGeomVerticesToPointsTool, wxGISGPProjectVectorTool, and wxGISGPMeanByColumnTool.

const wxString wxGISGPTool::GetAsString ( void  )

virtual

Returns tool parameters as string

IGxCatalog *const wxGISGPTool::GetCatalog ( void  )

virtual

Returns pointer to catalog

virtual const wxString wxGISGPTool::GetCategory ( void  )

pure virtual

Returns tool category name. This is used in add tool to the toolbox dialog

Implemented in wxGISGPOrthoCorrectTool, wxGISGPShapeToTextTool, wxGISGPSubRasterByVectorTool, wxGISGPCompStatTool, wxGISGPCreateOverviewsTool, wxGISGPExportTool, wxGISGPGeomVerticesToPointsTool, wxGISGPProjectVectorTool, and wxGISGPMeanByColumnTool.

virtual const wxString wxGISGPTool::GetDisplayName ( void  )

pure virtual

Returns tool name for display in UI

Implemented in wxGISGPOrthoCorrectTool, wxGISGPShapeToTextTool, wxGISGPSubRasterByVectorTool, wxGISGPCompStatTool, wxGISGPCreateOverviewsTool, wxGISGPExportTool, wxGISGPGeomVerticesToPointsTool, wxGISGPProjectVectorTool, and wxGISGPMeanByColumnTool.

virtual const wxString wxGISGPTool::GetName ( void  )

pure virtual

Returns uniq tool name for internal use

Implemented in wxGISGPOrthoCorrectTool, wxGISGPShapeToTextTool, wxGISGPSubRasterByVectorTool, wxGISGPCompStatTool, wxGISGPCreateOverviewsTool, wxGISGPExportTool, wxGISGPGeomVerticesToPointsTool, wxGISGPProjectVectorTool, and wxGISGPMeanByColumnTool.

virtual GPParameters wxGISGPTool::GetParameterInfo ( void  )

pure virtual

Returns tool parameters

Implemented in wxGISGPOrthoCorrectTool, wxGISGPShapeToTextTool, wxGISGPSubRasterByVectorTool, wxGISGPCompStatTool, wxGISGPCreateOverviewsTool, wxGISGPExportTool, wxGISGPGeomVerticesToPointsTool, wxGISGPProjectVectorTool, and wxGISGPMeanByColumnTool.

Here is the caller graph for this function:

void wxGISGPTool::SetCatalog ( IGxCatalog *  pCatalog )

virtual

This function called by task manager before tool execution started

Parameters

pCatalog

The pointer to catalog

bool wxGISGPTool::SetFromString ( const wxString &  sParams )

virtual

Initialize the class from tool parameters, represented as string

Here is the call graph for this function:

Here is the caller graph for this function:

virtual bool wxGISGPTool::Validate ( void  )

pure virtual

Returns true if tool parameters are valid

Implemented in wxGISGPOrthoCorrectTool, wxGISGPShapeToTextTool, wxGISGPSubRasterByVectorTool, wxGISGPCompStatTool, wxGISGPCreateOverviewsTool, wxGISGPExportTool, wxGISGPGeomVerticesToPointsTool, wxGISGPProjectVectorTool, and wxGISGPMeanByColumnTool.

---

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

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