Kùzu C++ API
Loading...
Searching...
No Matches
kuzu::common::ProgressBar Class Reference

Progress bar for tracking the progress of a pipeline. Prints the progress of each query pipeline and the overall progress. More...

#include <progress_bar.h>

Public Member Functions

 ProgressBar ()
 
void addPipeline ()
 
void finishPipeline (uint64_t queryID)
 
void endProgress (uint64_t queryID)
 
void startProgress (uint64_t queryID)
 
void toggleProgressBarPrinting (bool enable)
 
void setShowProgressAfter (uint64_t showProgressAfter)
 
void updateProgress (uint64_t queryID, double curPipelineProgress)
 
void setDisplay (std::shared_ptr< ProgressBarDisplay > progressBarDipslay)
 
std::shared_ptr< ProgressBarDisplaygetDisplay ()
 
bool getProgressBarPrinting () const
 

Static Public Member Functions

static std::shared_ptr< ProgressBarDisplayDefaultProgressBarDisplay ()
 

Detailed Description

Progress bar for tracking the progress of a pipeline. Prints the progress of each query pipeline and the overall progress.

Constructor & Destructor Documentation

◆ ProgressBar()

kuzu::common::ProgressBar::ProgressBar ( )

Member Function Documentation

◆ addPipeline()

void kuzu::common::ProgressBar::addPipeline ( )

◆ DefaultProgressBarDisplay()

static std::shared_ptr< ProgressBarDisplay > kuzu::common::ProgressBar::DefaultProgressBarDisplay ( )
static

◆ endProgress()

void kuzu::common::ProgressBar::endProgress ( uint64_t queryID)

◆ finishPipeline()

void kuzu::common::ProgressBar::finishPipeline ( uint64_t queryID)

◆ getDisplay()

std::shared_ptr< ProgressBarDisplay > kuzu::common::ProgressBar::getDisplay ( )
inline

◆ getProgressBarPrinting()

bool kuzu::common::ProgressBar::getProgressBarPrinting ( ) const
inline

◆ setDisplay()

void kuzu::common::ProgressBar::setDisplay ( std::shared_ptr< ProgressBarDisplay > progressBarDipslay)

◆ setShowProgressAfter()

void kuzu::common::ProgressBar::setShowProgressAfter ( uint64_t showProgressAfter)

◆ startProgress()

void kuzu::common::ProgressBar::startProgress ( uint64_t queryID)

◆ toggleProgressBarPrinting()

void kuzu::common::ProgressBar::toggleProgressBarPrinting ( bool enable)

◆ updateProgress()

void kuzu::common::ProgressBar::updateProgress ( uint64_t queryID,
double curPipelineProgress )

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