GDAL
Public Member Functions | List of all members
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. More...
 
bool lineComplete ()
 Emit progress information saying that a line has been written to output. More...
 
bool emit (double fraction)
 Emit progress information saying that a fraction of work has been completed. More...
 

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
pfnProgressPointer to progress function.
pProgressArgPointer to progress function data.
expectedLinesNumber 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: