DGtal  1.0.0
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DGtal::TraceWriter Class Referenceabstract

Virtual Class to implement trace writers. More...

#include <DGtal/base/TraceWriter.h>

Inheritance diagram for DGtal::TraceWriter:
[legend]
Collaboration diagram for DGtal::TraceWriter:
[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
 Reference to the output stream. More...
 

Private Member Functions

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

Detailed Description

Virtual Class to implement trace writers.

Description of class 'TraceWriter'

Aim:

See also
testTrace.cpp

Definition at line 57 of file TraceWriter.h.

Constructor & Destructor Documentation

◆ TraceWriter() [1/2]

DGtal::TraceWriter::TraceWriter ( std::ostream &  aoutputStream)
inlineprotected

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

Definition at line 103 of file TraceWriter.h.

103 : myOutputStream(aoutputStream) {};
std::ostream & myOutputStream
Reference to the output stream.
Definition: TraceWriter.h:84

◆ TraceWriter() [2/2]

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

Copy constructor.

Parameters
otherthe object to clone. Forbidden by default.

Member Function Documentation

◆ isValid()

bool DGtal::TraceWriter::isValid ( ) const

Checks the validity/consistency of the object.

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

◆ operator=()

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

Assignment.

Parameters
otherthe object to copy.
Returns
a reference on 'this'. Forbidden by default.

◆ outputStream()

std::ostream& DGtal::TraceWriter::outputStream ( )
inline

Definition at line 84 of file TraceWriter.h.

84 {return myOutputStream;};
std::ostream & myOutputStream
Reference to the output stream.
Definition: TraceWriter.h:84

References myOutputStream.

◆ postfixReset()

virtual std::string DGtal::TraceWriter::postfixReset ( )
pure virtual

◆ prefixEmphase()

virtual std::string DGtal::TraceWriter::prefixEmphase ( )
pure virtual

◆ prefixError()

virtual std::string DGtal::TraceWriter::prefixError ( )
pure virtual

◆ prefixInfo()

virtual std::string DGtal::TraceWriter::prefixInfo ( )
pure virtual

◆ prefixWarning()

virtual std::string DGtal::TraceWriter::prefixWarning ( )
pure virtual

◆ selfDisplay()

void DGtal::TraceWriter::selfDisplay ( std::ostream &  out) const

Writes/Displays the object on an output stream.

Parameters
outthe output stream where the object is written.

Field Documentation

◆ myOutputStream

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

Reference to the output stream.

Definition at line 84 of file TraceWriter.h.

Referenced by outputStream().


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