Public Types | Public Member Functions | Protected Member Functions | Private Attributes

cmtk::ProgressConsole Class Reference

Progress indicator with console output. More...

#include <cmtkProgressConsole.h>

Inheritance diagram for cmtk::ProgressConsole:
Inheritance graph
[legend]
Collaboration diagram for cmtk::ProgressConsole:
Collaboration graph
[legend]

List of all members.

Public Types

typedef ProgressConsole Self
 This class.
typedef Progress Superclass
 Superclass.

Public Member Functions

 ProgressConsole (const std::string &programName=std::string(""))
 Default constructor: connect to progress indicator.
virtual ~ProgressConsole ()
 Destructor: finish things up.
virtual ResultEnum UpdateProgress ()
 Output progress to console.

Protected Member Functions

virtual void BeginVirtual (const double start, const double end, const double increment, const std::string &taskName)
 Begin a new level of progress reporting.

Private Attributes

std::string m_ProgramName
 Name of this program.
double m_TimeAtStart
 Process time at start of task.
bool m_InsideSlicer3
 Flag that indicates whether we're running inside of Slicer3.

Detailed Description

Progress indicator with console output.

This class displays the programm progress on the console, using cmtk::StdErr. If this process is being run from inside Slicer3, output is based on Slicer's XML-type progress reporting instead, and this is written to std::cout.

See also:
http://www.slicer.org/slicerWiki/index.php/Slicer3:Execution_Model_Documentation#Showing_Progress_in_an_Application

Definition at line 56 of file cmtkProgressConsole.h.


Member Typedef Documentation

This class.

Reimplemented from cmtk::Progress.

Definition at line 62 of file cmtkProgressConsole.h.

Superclass.

Definition at line 65 of file cmtkProgressConsole.h.


Member Data Documentation

Flag that indicates whether we're running inside of Slicer3.

Definition at line 88 of file cmtkProgressConsole.h.

Referenced by ProgressConsole(), UpdateProgress(), and ~ProgressConsole().

std::string cmtk::ProgressConsole::m_ProgramName [private]

Name of this program.

Definition at line 82 of file cmtkProgressConsole.h.

Referenced by ProgressConsole(), and ~ProgressConsole().

Process time at start of task.

Definition at line 85 of file cmtkProgressConsole.h.

Referenced by ~ProgressConsole().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines