TextStreamProgressMeter Class Reference

Textual progress indicator for batch programs. More...

Inheritance diagram for TextStreamProgressMeter:

Public Member Functions
	TextStreamProgressMeter (od_ostream &, unsigned short rowlen=cDefaultRowLen())
	~TextStreamProgressMeter ()
std::int64_t	nrDone () const override
void	operator++ () override
void	printMessage (const uiString &)
void	reset ()
void	setFinished () override
void	setMessage (const uiString &) override
void	setName (const char *) override
void	setNrDone (std::int64_t) override
void	setStarted () override
void	setTotalNr (std::int64_t t) override
void	skipProgress (bool yn) override
Public Member Functions inherited from ProgressMeter
virtual	~ProgressMeter ()
virtual void	setNrDoneText (const uiString &)

Static Public Member Functions
static int	cDefaultRowLen ()
static int	cNrCharsPerRow ()

Protected Member Functions
void	addProgress (int)
void	annotate (bool)

Protected Attributes
unsigned char	distcharidx_
bool	finished_
bool	inited_
std::int64_t	lastannotatednrdone_
Threads::Lock	lock_
uiString	message_
BufferString	name_
std::int64_t	nrdone_
std::int64_t	nrdoneperchar_
int	nrdotsonline_
int	oldtime_
unsigned short	rowlen_
bool	skipprog_
od_ostream &	strm_
std::int64_t	totalnr_

Detailed Description

Textual progress indicator for batch programs.

<>

Constructor & Destructor Documentation

TextStreamProgressMeter()

TextStreamProgressMeter::TextStreamProgressMeter	(	od_ostream &	,
		unsigned short	rowlen = cDefaultRowLen()
	)

~TextStreamProgressMeter()

TextStreamProgressMeter::~TextStreamProgressMeter

(

)

Member Function Documentation

addProgress()

void TextStreamProgressMeter::addProgress ( int  )

protected

annotate()

void TextStreamProgressMeter::annotate ( bool  )

protected

cDefaultRowLen()

static int TextStreamProgressMeter::cDefaultRowLen ( )

inlinestatic

cNrCharsPerRow()

static int TextStreamProgressMeter::cNrCharsPerRow ( )

inlinestatic

nrDone()

std::int64_t TextStreamProgressMeter::nrDone ( ) const

inlineoverridevirtual

Reimplemented from ProgressMeter.

operator++()

void TextStreamProgressMeter::operator++ ( )

overridevirtual

Implements ProgressMeter.

printMessage()

void TextStreamProgressMeter::printMessage

(

const uiString &

)

This setting will not reset unless you call it.

reset()

void TextStreamProgressMeter::reset

(

)

setFinished()

void TextStreamProgressMeter::setFinished ( )

overridevirtual

Reimplemented from ProgressMeter.

setMessage()

void TextStreamProgressMeter::setMessage ( const uiString &  )

overridevirtual

Reimplemented from ProgressMeter.

setName()

void TextStreamProgressMeter::setName ( const char *  )

overridevirtual

Reimplemented from ProgressMeter.

setNrDone()

void TextStreamProgressMeter::setNrDone ( std::int64_t  )

overridevirtual

Reimplemented from ProgressMeter.

setStarted()

void TextStreamProgressMeter::setStarted ( )

overridevirtual

Reimplemented from ProgressMeter.

setTotalNr()

void TextStreamProgressMeter::setTotalNr ( std::int64_t  t )

inlineoverridevirtual

Reimplemented from ProgressMeter.

skipProgress()

void TextStreamProgressMeter::skipProgress ( bool  yn )

inlineoverridevirtual

Force to skip progress info.

Reimplemented from ProgressMeter.

Member Data Documentation

distcharidx_

unsigned char TextStreamProgressMeter::distcharidx_

protected

finished_

bool TextStreamProgressMeter::finished_

protected

inited_

bool TextStreamProgressMeter::inited_

protected

lastannotatednrdone_

std::int64_t TextStreamProgressMeter::lastannotatednrdone_

protected

lock_

Threads::Lock TextStreamProgressMeter::lock_

protected

message_

uiString TextStreamProgressMeter::message_

protected

name_

BufferString TextStreamProgressMeter::name_

protected

nrdone_

std::int64_t TextStreamProgressMeter::nrdone_

protected

nrdoneperchar_

std::int64_t TextStreamProgressMeter::nrdoneperchar_

protected

nrdotsonline_

int TextStreamProgressMeter::nrdotsonline_

protected

oldtime_

int TextStreamProgressMeter::oldtime_

protected

rowlen_

unsigned short TextStreamProgressMeter::rowlen_

protected

skipprog_

bool TextStreamProgressMeter::skipprog_

protected

strm_

od_ostream& TextStreamProgressMeter::strm_

protected

totalnr_

std::int64_t TextStreamProgressMeter::totalnr_

protected