AppBase::ProgressTask Struct Reference

desribes a subprogess task A progress task describes one operation More...

#include <ProgressDisplayOld.h>

List of all members.

Public Member Functions

 ProgressTask (std::string shortMessage, std::string message, double subStepProgress, double progress=0)
 ProgressTask (std::string shortMessage, std::string message)
 create a progress task without a progress percentage display
const std::stringgetShortMessage ()
const std::stringgetMessage ()
double getProgress ()

Public Attributes

std::string shortMessage
std::string message
double subStepProgress
double progress
bool measureProgress
double last_displayed_progress


Detailed Description

desribes a subprogess task A progress task describes one operation

it consists of a one or two word heading, shortMessage and a longer description, message.

Progress can be set directly, or with substeps, subStepProgress

nSteps * subStepProgress = 100%. The progress is also increased by a subStep, if a lower operation completes.

Definition at line 53 of file ProgressDisplayOld.h.


Constructor & Destructor Documentation

AppBase::ProgressTask::ProgressTask ( std::string  shortMessage,
std::string  message,
double  subStepProgress,
double  progress = 0 
)

Definition at line 33 of file ProgressDisplayOld.cpp.

AppBase::ProgressTask::ProgressTask ( std::string  shortMessage,
std::string  message 
)

create a progress task without a progress percentage display

Definition at line 42 of file ProgressDisplayOld.cpp.


Member Function Documentation

const std::string& AppBase::ProgressTask::getMessage (  )  [inline]

Definition at line 74 of file ProgressDisplayOld.h.

double AppBase::ProgressTask::getProgress (  )  [inline]

Definition at line 77 of file ProgressDisplayOld.h.

const std::string& AppBase::ProgressTask::getShortMessage (  )  [inline]

Definition at line 71 of file ProgressDisplayOld.h.


Member Data Documentation

double AppBase::ProgressTask::last_displayed_progress

Definition at line 69 of file ProgressDisplayOld.h.

bool AppBase::ProgressTask::measureProgress

Definition at line 68 of file ProgressDisplayOld.h.

std::string AppBase::ProgressTask::message

Definition at line 64 of file ProgressDisplayOld.h.

double AppBase::ProgressTask::progress

Definition at line 66 of file ProgressDisplayOld.h.

std::string AppBase::ProgressTask::shortMessage

Definition at line 63 of file ProgressDisplayOld.h.

double AppBase::ProgressTask::subStepProgress

Definition at line 65 of file ProgressDisplayOld.h.


The documentation for this struct was generated from the following files:
Generated on 5 Dec 2014 for Hugintrunk by  doxygen 1.4.7