OpendTect  7.0
Public Member Functions | Protected Attributes | List of all members
ProgressRecorder Class Reference

ProgressMeter that helps unifying different tasks. More...

Inheritance diagram for ProgressRecorder:
[legend]

Public Member Functions

 ProgressRecorder ()
 
 ~ProgressRecorder ()
 
ProgressMeterforwardTo () const
 
bool isFinished () const
 
bool isStarted () const
 
uiString message () const
 
const char * name () const
 
std::int64_t nrDone () const override
 
uiString nrDoneText () const
 
void operator++ () override
 
void reset ()
 
void setFinished () override
 
void setForwardTo (ProgressMeter *)
 
void setFrom (const Task &)
 
void setMessage (const uiString &) override
 
void setMessage (const uiString &, bool printtolog)
 
void setName (const char *) override
 
void setNrDone (std::int64_t) override
 
void setNrDoneText (const uiString &) override
 
void setStarted () override
 
void setTotalNr (std::int64_t) override
 
void skipProgress (bool) override
 
std::int64_t totalNr () const
 
- Public Member Functions inherited from ProgressMeter
virtual ~ProgressMeter ()
 

Protected Attributes

ProgressMeterforwardto_
 
bool isfinished_
 
bool isstarted_
 
Threads::Locklock_
 
uiString message_
 
BufferString name_
 
std::int64_t nrdone_
 
uiString nrdonetext_
 
std::int64_t totalnr_
 

Detailed Description

ProgressMeter that helps unifying different tasks.

<>

Constructor & Destructor Documentation

◆ ProgressRecorder()

ProgressRecorder::ProgressRecorder ( )

◆ ~ProgressRecorder()

ProgressRecorder::~ProgressRecorder ( )

Member Function Documentation

◆ forwardTo()

ProgressMeter* ProgressRecorder::forwardTo ( ) const

◆ isFinished()

bool ProgressRecorder::isFinished ( ) const

◆ isStarted()

bool ProgressRecorder::isStarted ( ) const

◆ message()

uiString ProgressRecorder::message ( ) const

◆ name()

const char* ProgressRecorder::name ( ) const

◆ nrDone()

std::int64_t ProgressRecorder::nrDone ( ) const
overridevirtual

Reimplemented from ProgressMeter.

◆ nrDoneText()

uiString ProgressRecorder::nrDoneText ( ) const

◆ operator++()

void ProgressRecorder::operator++ ( )
overridevirtual

Implements ProgressMeter.

◆ reset()

void ProgressRecorder::reset ( )

◆ setFinished()

void ProgressRecorder::setFinished ( )
overridevirtual

Reimplemented from ProgressMeter.

◆ setForwardTo()

void ProgressRecorder::setForwardTo ( ProgressMeter )

◆ setFrom()

void ProgressRecorder::setFrom ( const Task )

◆ setMessage() [1/2]

void ProgressRecorder::setMessage ( const uiString )
overridevirtual

Reimplemented from ProgressMeter.

◆ setMessage() [2/2]

void ProgressRecorder::setMessage ( const uiString ,
bool  printtolog 
)

◆ setName()

void ProgressRecorder::setName ( const char *  )
overridevirtual

Reimplemented from ProgressMeter.

◆ setNrDone()

void ProgressRecorder::setNrDone ( std::int64_t  )
overridevirtual

Reimplemented from ProgressMeter.

◆ setNrDoneText()

void ProgressRecorder::setNrDoneText ( const uiString )
overridevirtual

Reimplemented from ProgressMeter.

◆ setStarted()

void ProgressRecorder::setStarted ( )
overridevirtual

Reimplemented from ProgressMeter.

◆ setTotalNr()

void ProgressRecorder::setTotalNr ( std::int64_t  )
overridevirtual

Reimplemented from ProgressMeter.

◆ skipProgress()

void ProgressRecorder::skipProgress ( bool  yn)
overridevirtual

Force to skip progress info.

Reimplemented from ProgressMeter.

◆ totalNr()

std::int64_t ProgressRecorder::totalNr ( ) const

Member Data Documentation

◆ forwardto_

ProgressMeter* ProgressRecorder::forwardto_
protected

◆ isfinished_

bool ProgressRecorder::isfinished_
protected

◆ isstarted_

bool ProgressRecorder::isstarted_
protected

◆ lock_

Threads::Lock& ProgressRecorder::lock_
protected

◆ message_

uiString ProgressRecorder::message_
protected

◆ name_

BufferString ProgressRecorder::name_
protected

◆ nrdone_

std::int64_t ProgressRecorder::nrdone_
protected

◆ nrdonetext_

uiString ProgressRecorder::nrdonetext_
protected

◆ totalnr_

std::int64_t ProgressRecorder::totalnr_
protected

Generated at for the OpendTect seismic interpretation project. Copyright (C): dGB Beheer B.V. 1995-2024