Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions

DGtal::TraceWriter Class Reference

#include <TraceWriter.h>

Inheritance diagram for DGtal::TraceWriter:
Inheritance graph
[legend]

Public Member Functions

void selfDisplay (std::ostream &out) const
bool isValid () const
virtual std::string prefixWarning ()=0
virtual std::string prefixInfo ()=0
virtual std::string prefixError ()=0
virtual std::string prefixEmphase ()=0
virtual std::string postfixReset ()=0
std::ostream & outputStream ()

Protected Member Functions

 TraceWriter (std::ostream &aoutputStream)

Protected Attributes

std::ostream & myOutputStream

Private Member Functions

 TraceWriter (const TraceWriter &other)
TraceWriteroperator= (const TraceWriter &other)

Detailed Description

Description of class 'TraceWriter'

Aim: Virtual Class to implement trace writers.


Constructor & Destructor Documentation

DGtal::TraceWriter::TraceWriter ( std::ostream &  aoutputStream  )  [inline, protected]

Constructor. Forbidden by default (protected to avoid g++ warnings).

DGtal::TraceWriter::TraceWriter ( const TraceWriter other  )  [private]

Copy constructor.

Parameters:
other the object to clone. Forbidden by default.

Member Function Documentation

bool DGtal::TraceWriter::isValid (  )  const

Checks the validity/consistency of the object.

Returns:
'true' if the object is valid, 'false' otherwise.

Reimplemented in DGtal::TraceWriterFile, and DGtal::TraceWriterTerm.

TraceWriter& DGtal::TraceWriter::operator= ( const TraceWriter other  )  [private]

Assignment.

Parameters:
other the object to copy.
Returns:
a reference on 'this'. Forbidden by default.
std::ostream& DGtal::TraceWriter::outputStream (  )  [inline]

References myOutputStream.

virtual std::string DGtal::TraceWriter::postfixReset (  )  [pure virtual]
virtual std::string DGtal::TraceWriter::prefixEmphase (  )  [pure virtual]
virtual std::string DGtal::TraceWriter::prefixError (  )  [pure virtual]
virtual std::string DGtal::TraceWriter::prefixInfo (  )  [pure virtual]
virtual std::string DGtal::TraceWriter::prefixWarning (  )  [pure virtual]
void DGtal::TraceWriter::selfDisplay ( std::ostream &  out  )  const

Writes/Displays the object on an output stream.

Parameters:
out the output stream where the object is written.

Reimplemented in DGtal::TraceWriterFile, and DGtal::TraceWriterTerm.


Field Documentation

std::ostream& DGtal::TraceWriter::myOutputStream [protected]

Reference to the output stream.

Referenced by outputStream().


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