iRoCS Toolbox  1.1.0
Public Member Functions | Protected Attributes
iRoCS::ProgressReporterStream Class Reference

#include <ProgressReporterStream.hh>

Inheritance diagram for iRoCS::ProgressReporterStream:
Collaboration diagram for iRoCS::ProgressReporterStream:

Public Member Functions

 ProgressReporterStream (std::ostream &os=std::cout, int progress=0, int progressMin=0, int progressMax=100, std::string const &headerMessage=std::string(), std::string const &progressMessage=std::string())
 
 ~ProgressReporterStream ()
 
void abort ()
 
void abortWithError (std::string const &msg)
 
std::string headerMessage () const
 
bool isAborted () const
 
template<typename DataT >
ProgressReporterStreamoperator<< (DataT const &msg)
 Appends the given message to the selected output stream. More...
 
int progress () const
 
int progressMax () const
 
std::string progressMessage () const
 
int progressMin () const
 
void setAborted (bool abort)
 
void setHeaderMessage (std::string const &message)
 
void setProgress (int progress)
 
void setProgressMax (int progressMax)
 
void setProgressMessage (std::string const &message)
 
void setProgressMin (int progressMin)
 
void setTaskProgressMax (int progressMax)
 
void setTaskProgressMin (int progressMin)
 
void setTaskProgressRange (int progressMin, int progressMax)
 
int taskProgressMax () const
 
int taskProgressMin () const
 
bool updateProgress (int progress)
 
bool updateProgressMessage (std::string const &message)
 

Protected Attributes

int _taskProgressMax
 
int _taskProgressMin
 

Detailed Description

Definition at line 37 of file ProgressReporterStream.hh.

Constructor & Destructor Documentation

◆ ProgressReporterStream()

iRoCS::ProgressReporterStream::ProgressReporterStream ( std::ostream &  os = std::cout,
int  progress = 0,
int  progressMin = 0,
int  progressMax = 100,
std::string const &  headerMessage = std::string(),
std::string const &  progressMessage = std::string() 
)

◆ ~ProgressReporterStream()

iRoCS::ProgressReporterStream::~ProgressReporterStream ( )

Member Function Documentation

◆ setProgressMin()

void iRoCS::ProgressReporterStream::setProgressMin ( int  progressMin)
virtual

◆ progressMin()

int iRoCS::ProgressReporterStream::progressMin ( ) const
virtual

◆ setProgressMax()

void iRoCS::ProgressReporterStream::setProgressMax ( int  progressMax)
virtual

◆ progressMax()

int iRoCS::ProgressReporterStream::progressMax ( ) const
virtual

◆ setHeaderMessage()

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

◆ headerMessage()

std::string iRoCS::ProgressReporterStream::headerMessage ( ) const
virtual

◆ setProgressMessage()

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

◆ progressMessage()

std::string iRoCS::ProgressReporterStream::progressMessage ( ) const
virtual

◆ setProgress()

void iRoCS::ProgressReporterStream::setProgress ( int  progress)
virtual

◆ progress()

int iRoCS::ProgressReporterStream::progress ( ) const
virtual

◆ setAborted()

void iRoCS::ProgressReporterStream::setAborted ( bool  abort)
virtual

◆ abort()

void iRoCS::ProgressReporterStream::abort ( )
virtual

◆ abortWithError()

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

◆ isAborted()

bool iRoCS::ProgressReporterStream::isAborted ( ) const
virtual

◆ updateProgress()

bool iRoCS::ProgressReporterStream::updateProgress ( int  progress)
virtual

◆ updateProgressMessage()

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

◆ operator<<()

template<typename DataT >
ProgressReporterStream & iRoCS::ProgressReporterStream::operator<< ( DataT const &  msg)

Appends the given message to the selected output stream.

Parameters
msgThe message to append (may be also stream control commands)

Definition at line 103 of file ProgressReporterStream.hh.

◆ setTaskProgressRange()

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

◆ setTaskProgressMin()

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

◆ taskProgressMin()

int iRoCS::ProgressReporter::taskProgressMin ( ) const
inherited

◆ setTaskProgressMax()

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

◆ taskProgressMax()

int iRoCS::ProgressReporter::taskProgressMax ( ) const
inherited

Field Documentation

◆ _taskProgressMin

int iRoCS::ProgressReporter::_taskProgressMin
protectedinherited

Definition at line 103 of file ProgressReporter.hh.

◆ _taskProgressMax

int iRoCS::ProgressReporter::_taskProgressMax
protectedinherited

Definition at line 103 of file ProgressReporter.hh.


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