HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ROP_Verbose Class Reference

#include <ROP_Verbose.h>

Public Member Functions

 ROP_Verbose (std::ostream *os=NULL)
 
 ROP_Verbose (const ROP_Verbose &s)
 
 ~ROP_Verbose ()
 
void clear ()
 Clear (i.e. set the stream to null & clear levels. More...
 
bool isValid () const
 Check to see if the stream is valid. More...
 
bool isLevel (int level) const
 
ROP_Verboseoperator= (const ROP_Verbose &s)
 Assignment operator. More...
 
void setFrom (const ROP_Verbose *s)
 Copy from a source verbose or clear if the source is NULL. More...
 
void showProgress (fpreal percent) const
 Print out progress (percent should be 0-1) More...
 
void showProgress (int current, int total) const
 Print out progress based on counts. More...
 
std::ostream * getStream () const
 
void setStream (std::ostream *s)
 
int getLevel () const
 
void setLevel (int level)
 
bool getAlfred () const
 
void setAlfred (bool flag=true)
 

Detailed Description

Definition at line 20 of file ROP_Verbose.h.

Constructor & Destructor Documentation

ROP_Verbose::ROP_Verbose ( std::ostream *  os = NULL)
inline

Definition at line 22 of file ROP_Verbose.h.

ROP_Verbose::ROP_Verbose ( const ROP_Verbose s)
inline

Definition at line 28 of file ROP_Verbose.h.

ROP_Verbose::~ROP_Verbose ( )
inline

Definition at line 34 of file ROP_Verbose.h.

Member Function Documentation

void ROP_Verbose::clear ( void  )
inline

Clear (i.e. set the stream to null & clear levels.

Definition at line 39 of file ROP_Verbose.h.

bool ROP_Verbose::getAlfred ( ) const
inline

Manage the alfred flag (turns on alfred style progress)

Definition at line 91 of file ROP_Verbose.h.

int ROP_Verbose::getLevel ( ) const
inline

Manage the verbosity level

Definition at line 85 of file ROP_Verbose.h.

std::ostream* ROP_Verbose::getStream ( ) const
inline

Manage the output stream

Definition at line 79 of file ROP_Verbose.h.

bool ROP_Verbose::isLevel ( int  level) const
inline

Check verbosity level. For example:

if (verbose.isLevel(2))
detailedInformation();
else if (verbose.isLevel(1))
briefInformation();

Definition at line 56 of file ROP_Verbose.h.

bool ROP_Verbose::isValid ( void  ) const
inline

Check to see if the stream is valid.

Definition at line 47 of file ROP_Verbose.h.

ROP_Verbose& ROP_Verbose::operator= ( const ROP_Verbose s)
inline

Assignment operator.

Definition at line 60 of file ROP_Verbose.h.

void ROP_Verbose::setAlfred ( bool  flag = true)
inline

Manage the alfred flag (turns on alfred style progress)

Definition at line 92 of file ROP_Verbose.h.

void ROP_Verbose::setFrom ( const ROP_Verbose s)
inline

Copy from a source verbose or clear if the source is NULL.

Definition at line 69 of file ROP_Verbose.h.

void ROP_Verbose::setLevel ( int  level)
inline

Manage the verbosity level

Definition at line 86 of file ROP_Verbose.h.

void ROP_Verbose::setStream ( std::ostream *  s)
inline

Manage the output stream

Definition at line 80 of file ROP_Verbose.h.

void ROP_Verbose::showProgress ( fpreal  percent) const
inline

Print out progress (percent should be 0-1)

Definition at line 96 of file ROP_Verbose.h.

void ROP_Verbose::showProgress ( int  current,
int  total 
) const
inline

Print out progress based on counts.

Definition at line 108 of file ROP_Verbose.h.


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