ROP_Verbose Class Reference

#include <ROP_Verbose.h>

List of all members.

Public Member Functions

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


Detailed Description

Definition at line 25 of file ROP_Verbose.h.


Constructor & Destructor Documentation

ROP_Verbose::ROP_Verbose ( ostream *  os = NULL  )  [inline]

Definition at line 27 of file ROP_Verbose.h.

ROP_Verbose::ROP_Verbose ( const ROP_Verbose s  )  [inline]

Definition at line 33 of file ROP_Verbose.h.

ROP_Verbose::~ROP_Verbose (  )  [inline]

Definition at line 39 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 44 of file ROP_Verbose.h.

bool ROP_Verbose::getAlfred (  )  const [inline]

Manage the alfred flag (turns on alfred style progress)

Definition at line 96 of file ROP_Verbose.h.

int ROP_Verbose::getLevel (  )  const [inline]

Manage the verbosity level

Definition at line 90 of file ROP_Verbose.h.

ostream* ROP_Verbose::getStream (  )  const [inline]

Manage the output stream

Definition at line 84 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 61 of file ROP_Verbose.h.

bool ROP_Verbose::isValid ( void   )  const [inline]

Check to see if the stream is valid.

Definition at line 52 of file ROP_Verbose.h.

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

Assignment operator.

Definition at line 65 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 97 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 74 of file ROP_Verbose.h.

void ROP_Verbose::setLevel ( int  level  )  [inline]

Manage the verbosity level

Definition at line 91 of file ROP_Verbose.h.

void ROP_Verbose::setStream ( ostream *  s  )  [inline]

Manage the output stream

Definition at line 85 of file ROP_Verbose.h.

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

Print out progress based on counts.

Definition at line 113 of file ROP_Verbose.h.

void ROP_Verbose::showProgress ( fpreal  percent  )  const [inline]

Print out progress (percent should be 0-1).

Definition at line 101 of file ROP_Verbose.h.


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

Generated on Mon Jan 28 00:29:52 2013 for HDK by  doxygen 1.5.9