FEMSuite
Public Member Functions | Protected Attributes | List of all members
Progressor Class Reference

This class stores the progress levels of computationally intensive processes and can be used by the GUI to display progress bars, etc. More...

#include <Progressor.h>

Collaboration diagram for Progressor:
Collaboration graph
[legend]

Public Member Functions

std::string GetName () const
 
void SetName (const std::string &name)
 
Extrema< double > GetLimits () const
 
void SetLimits (const Extrema< double > &limits)
 
std::pair< double, std::string > GetCurrentStage () const
 
void SetCurrentStage (const double stage, const std::string &description)
 
bool IsComplete () const
 
void SetComplete (const bool c=true)
 
bool IsAborted () const
 
bool ShouldAbort () const
 
void Abort ()
 
void Reset ()
 Resets progress levels and complete flag More...
 
void Initiate ()
 
bool IsInitiated () const
 
unsigned char GetPercentComplete () const
 
 Progressor (const std::string &name)
 

Protected Attributes

std::string m_Name
 
Extrema< double > m_Limits
 
std::pair< double, std::string > m_CurrentStage
 
bool m_Complete
 This signals that progress is complete. More...
 
bool m_ShouldAbort
 This signals that progress should be aborted. More...
 
bool m_Initiated
 Signals that a process has been initated. More...
 

Detailed Description

This class stores the progress levels of computationally intensive processes and can be used by the GUI to display progress bars, etc.

Member Function Documentation

void Progressor::Reset ( )

Resets progress levels and complete flag

Member Data Documentation

bool Progressor::m_Complete
protected

This signals that progress is complete.

bool Progressor::m_Initiated
protected

Signals that a process has been initated.

bool Progressor::m_ShouldAbort
protected

This signals that progress should be aborted.


The documentation for this class was generated from the following files: