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 ()
void	setName (const char *)
void	setStarted ()
void	setFinished ()
void	setNrDone (int64_t)
void	setTotalNr (int64_t t)
void	setMessage (const uiString &)
void	printMessage (const uiString &)
void	skipProgress (bool yn)
void	operator++ ()
int64_t	nrDone () const
void	reset ()
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
od_ostream &	strm_
uiString	message_
BufferString	name_
unsigned short	rowlen_
unsigned char	distcharidx_
int64_t	nrdoneperchar_
int64_t	nrdone_
int64_t	lastannotatednrdone_
int64_t	totalnr_
int	oldtime_
int	nrdotsonline_
bool	inited_
bool	finished_
Threads::Lock	lock_
bool	skipprog_

Detailed Description

Textual progress indicator for batch programs.

Constructor & Destructor Documentation

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

TextStreamProgressMeter::~TextStreamProgressMeter

(

)

Member Function Documentation

void TextStreamProgressMeter::addProgress ( int  )

protected

void TextStreamProgressMeter::annotate ( bool  )

protected

static int TextStreamProgressMeter::cDefaultRowLen ( )

inlinestatic

static int TextStreamProgressMeter::cNrCharsPerRow ( )

inlinestatic

int64_t TextStreamProgressMeter::nrDone ( ) const

inlinevirtual

Reimplemented from ProgressMeter.

void TextStreamProgressMeter::operator++ ( )

virtual

Implements ProgressMeter.

void TextStreamProgressMeter::printMessage

(

const uiString &

)

This setting will not reset unless you call it.

void TextStreamProgressMeter::reset

(

)

void TextStreamProgressMeter::setFinished ( )

virtual

Reimplemented from ProgressMeter.

void TextStreamProgressMeter::setMessage ( const uiString &  )

virtual

Reimplemented from ProgressMeter.

void TextStreamProgressMeter::setName ( const char *  )

virtual

Reimplemented from ProgressMeter.

void TextStreamProgressMeter::setNrDone ( int64_t  )

virtual

Reimplemented from ProgressMeter.

void TextStreamProgressMeter::setStarted ( )

virtual

Reimplemented from ProgressMeter.

void TextStreamProgressMeter::setTotalNr ( int64_t  t )

inlinevirtual

Reimplemented from ProgressMeter.

void TextStreamProgressMeter::skipProgress ( bool  yn )

inlinevirtual

Force to skip progress info.

Reimplemented from ProgressMeter.

Member Data Documentation

unsigned char TextStreamProgressMeter::distcharidx_

protected

bool TextStreamProgressMeter::finished_

protected

bool TextStreamProgressMeter::inited_

protected

int64_t TextStreamProgressMeter::lastannotatednrdone_

protected

Threads::Lock TextStreamProgressMeter::lock_

protected

uiString TextStreamProgressMeter::message_

protected

BufferString TextStreamProgressMeter::name_

protected

int64_t TextStreamProgressMeter::nrdone_

protected

int64_t TextStreamProgressMeter::nrdoneperchar_

protected

int TextStreamProgressMeter::nrdotsonline_

protected

int TextStreamProgressMeter::oldtime_

protected

unsigned short TextStreamProgressMeter::rowlen_

protected

bool TextStreamProgressMeter::skipprog_

protected

od_ostream& TextStreamProgressMeter::strm_

protected

int64_t TextStreamProgressMeter::totalnr_

protected