PBD::Progress Class Reference

#include <progress.h>

Inheritance diagram for PBD::Progress:

Classes
struct	Level

Public Member Functions
	Progress ()
virtual	~Progress ()
void	set_progress (float)
void	ascend ()
void	descend (float)
bool	cancelled () const

Protected Member Functions
void	cancel ()

Private Member Functions
virtual void	set_overall_progress (float p)=0

Private Attributes
std::list< Level >	_stack
bool	_cancelled

Detailed Description

A class to handle reporting of progress of something

Definition at line 29 of file progress.h.

Constructor & Destructor Documentation

Progress()

PBD::Progress::Progress

(

)

~Progress()

virtual PBD::Progress::~Progress ( )

inlinevirtual

Definition at line 33 of file progress.h.

Member Function Documentation

ascend()

void PBD::Progress::ascend

(

)

cancel()

void PBD::Progress::cancel ( )

protected

cancelled()

bool PBD::Progress::cancelled

(

)

const

descend()

void PBD::Progress::descend

(

float

)

set_overall_progress()

virtual void PBD::Progress::set_overall_progress ( float  p )

privatepure virtual

Report overall progress.

Parameters

p	Current progress (from 0 to 1)

Implemented in ProgressReporter, and PBD::Inflater.

set_progress()

void PBD::Progress::set_progress

(

float

)

Member Data Documentation

_cancelled

bool PBD::Progress::_cancelled

private

Definition at line 58 of file progress.h.

_stack

std::list<Level> PBD::Progress::_stack

private

Definition at line 57 of file progress.h.

---

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

• progress.h