iRoCS Toolbox  1.1.0
Public Member Functions | Protected Attributes
iRoCS::ProgressReporter Class Referenceabstract

#include <ProgressReporter.hh>

Inheritance diagram for iRoCS::ProgressReporter:
Collaboration diagram for iRoCS::ProgressReporter:

Public Member Functions

 ProgressReporter ()
 
virtual ~ProgressReporter ()
 
virtual void abort ()=0
 
virtual void abortWithError (std::string const &msg)=0
 
virtual std::string headerMessage () const =0
 
virtual bool isAborted () const =0
 
virtual int progress () const =0
 
virtual int progressMax () const =0
 
virtual std::string progressMessage () const =0
 
virtual int progressMin () const =0
 
virtual void setAborted (bool abort)=0
 
virtual void setHeaderMessage (std::string const &message)=0
 
virtual void setProgress (int progress)=0
 
virtual void setProgressMax (int progressMax)=0
 
virtual void setProgressMessage (std::string const &message)=0
 
virtual void setProgressMin (int progressMin)=0
 
void setTaskProgressMax (int progressMax)
 
void setTaskProgressMin (int progressMin)
 
void setTaskProgressRange (int progressMin, int progressMax)
 
int taskProgressMax () const
 
int taskProgressMin () const
 
virtual bool updateProgress (int progress)=0
 
virtual bool updateProgressMessage (std::string const &message)=0
 

Protected Attributes

int _taskProgressMax
 
int _taskProgressMin
 

Detailed Description

Definition at line 47 of file ProgressReporter.hh.

Constructor & Destructor Documentation

◆ ProgressReporter()

iRoCS::ProgressReporter::ProgressReporter ( )
inline

Definition at line 52 of file ProgressReporter.hh.

◆ ~ProgressReporter()

virtual iRoCS::ProgressReporter::~ProgressReporter ( )
inlinevirtual

Definition at line 56 of file ProgressReporter.hh.

Member Function Documentation

◆ setProgressMin()

virtual void iRoCS::ProgressReporter::setProgressMin ( int  progressMin)
pure virtual

◆ progressMin()

virtual int iRoCS::ProgressReporter::progressMin ( ) const
pure virtual

◆ setProgressMax()

virtual void iRoCS::ProgressReporter::setProgressMax ( int  progressMax)
pure virtual

◆ progressMax()

virtual int iRoCS::ProgressReporter::progressMax ( ) const
pure virtual

◆ setTaskProgressRange()

void iRoCS::ProgressReporter::setTaskProgressRange ( int  progressMin,
int  progressMax 
)

◆ setTaskProgressMin()

void iRoCS::ProgressReporter::setTaskProgressMin ( int  progressMin)

◆ taskProgressMin()

int iRoCS::ProgressReporter::taskProgressMin ( ) const

◆ setTaskProgressMax()

void iRoCS::ProgressReporter::setTaskProgressMax ( int  progressMax)

◆ taskProgressMax()

int iRoCS::ProgressReporter::taskProgressMax ( ) const

◆ setHeaderMessage()

virtual void iRoCS::ProgressReporter::setHeaderMessage ( std::string const &  message)
pure virtual

◆ headerMessage()

virtual std::string iRoCS::ProgressReporter::headerMessage ( ) const
pure virtual

◆ setProgressMessage()

virtual void iRoCS::ProgressReporter::setProgressMessage ( std::string const &  message)
pure virtual

◆ progressMessage()

virtual std::string iRoCS::ProgressReporter::progressMessage ( ) const
pure virtual

◆ setProgress()

virtual void iRoCS::ProgressReporter::setProgress ( int  progress)
pure virtual

◆ progress()

virtual int iRoCS::ProgressReporter::progress ( ) const
pure virtual

◆ setAborted()

virtual void iRoCS::ProgressReporter::setAborted ( bool  abort)
pure virtual

◆ abort()

virtual void iRoCS::ProgressReporter::abort ( )
pure virtual

◆ abortWithError()

virtual void iRoCS::ProgressReporter::abortWithError ( std::string const &  msg)
pure virtual

◆ isAborted()

virtual bool iRoCS::ProgressReporter::isAborted ( ) const
pure virtual

◆ updateProgress()

virtual bool iRoCS::ProgressReporter::updateProgress ( int  progress)
pure virtual

◆ updateProgressMessage()

virtual bool iRoCS::ProgressReporter::updateProgressMessage ( std::string const &  message)
pure virtual

Field Documentation

◆ _taskProgressMin

int iRoCS::ProgressReporter::_taskProgressMin
protected

Definition at line 103 of file ProgressReporter.hh.

◆ _taskProgressMax

int iRoCS::ProgressReporter::_taskProgressMax
protected

Definition at line 103 of file ProgressReporter.hh.


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