gdal::viewshed::Progress Class Reference

Support for progress reporting in viewshed construction. More...

#include <progress.h>

Public Member Functions
	Progress (GDALProgressFunc pfnProgress, void *pProgressArg, size_t expectedLines)
	Constructor.
bool	lineComplete ()
	Emit progress information saying that a line has been written to output.
bool	emit (double fraction)
	Emit progress information saying that a fraction of work has been completed.

Detailed Description

Support for progress reporting in viewshed construction.

Determines the faction of progress made based on the number of raster lines completed.

Constructor & Destructor Documentation

Progress()

gdal::viewshed::Progress::Progress	(	GDALProgressFunc	pfnProgress,
		void *	pProgressArg,
		size_t	expectedLines )

Constructor.

Parameters

pfnProgress	Pointer to progress function.
pProgressArg	Pointer to progress function data.
expectedLines	Number of lines expected to be processed.

Member Function Documentation

emit()

bool gdal::viewshed::Progress::emit

(

double

fraction

)

Emit progress information saying that a fraction of work has been completed.

Returns

True on success, false otherwise.

lineComplete()

bool gdal::viewshed::Progress::lineComplete

(

)

Emit progress information saying that a line has been written to output.

Returns

True on success, false otherwise.

---

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

• progress.h
• progress.cpp