DGtal  1.2.0
Public Member Functions | Private Member Functions
DGtal::TraceWriterFile Class Reference

#include <DGtal/base/TraceWriterFile.h>

Inheritance diagram for DGtal::TraceWriterFile:
[legend]

Public Member Functions

 TraceWriterFile (std::ostream &aoutputStream)
 
 ~TraceWriterFile ()
 
void selfDisplay (std::ostream &out) const
 
bool isValid () const
 
std::string prefixWarning ()
 
std::string prefixInfo ()
 
std::string prefixError ()
 
std::string prefixEmphase ()
 
std::string postfixReset ()
 
- Public Member Functions inherited from DGtal::TraceWriter
void selfDisplay (std::ostream &out) const
 
bool isValid () const
 
std::ostream & outputStream ()
 

Private Member Functions

 TraceWriterFile (const TraceWriterFile &other)
 
TraceWriterFileoperator= (const TraceWriterFile &other)
 

Additional Inherited Members

- Protected Member Functions inherited from DGtal::TraceWriter
 TraceWriter (std::ostream &aoutputStream)
 
- Protected Attributes inherited from DGtal::TraceWriter
std::ostream & myOutputStream
 Reference to the output stream. More...
 

Detailed Description

Description of class 'TraceWriterFile'

Aim:

Definition at line 56 of file TraceWriterFile.h.

Constructor & Destructor Documentation

◆ TraceWriterFile() [1/2]

DGtal::TraceWriterFile::TraceWriterFile ( std::ostream &  aoutputStream)
inline

Constructor.

Parameters
aoutputStreamthe current output Stream

Definition at line 67 of file TraceWriterFile.h.

67 : TraceWriter(aoutputStream) {};
TraceWriter(std::ostream &aoutputStream)
Definition: TraceWriter.h:103

◆ ~TraceWriterFile()

DGtal::TraceWriterFile::~TraceWriterFile ( )
inline

Destructor.

Definition at line 75 of file TraceWriterFile.h.

75 {};

◆ TraceWriterFile() [2/2]

DGtal::TraceWriterFile::TraceWriterFile ( const TraceWriterFile other)
private

Copy constructor.

Parameters
otherthe object to clone. Forbidden by default.

Member Function Documentation

◆ isValid()

bool DGtal::TraceWriterFile::isValid ( ) const

Checks the validity/consistency of the object.

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

◆ operator=()

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

Assignment.

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

◆ postfixReset()

std::string DGtal::TraceWriterFile::postfixReset ( )
inlinevirtual

Create an Reset postfix

Returns
the postix

Implements DGtal::TraceWriter.

Definition at line 121 of file TraceWriterFile.h.

121 {return "";}

◆ prefixEmphase()

std::string DGtal::TraceWriterFile::prefixEmphase ( )
inlinevirtual

Create an Emphase Prefix

Returns
the prefix

Implements DGtal::TraceWriter.

Definition at line 115 of file TraceWriterFile.h.

115 {return "";}

◆ prefixError()

std::string DGtal::TraceWriterFile::prefixError ( )
inlinevirtual

Create an Error Prefix

Returns
the prefix

Implements DGtal::TraceWriter.

Definition at line 109 of file TraceWriterFile.h.

109 {return "[ERR]";}

◆ prefixInfo()

std::string DGtal::TraceWriterFile::prefixInfo ( )
inlinevirtual

Create an Info Prefix

Returns
the prefix

Implements DGtal::TraceWriter.

Definition at line 103 of file TraceWriterFile.h.

103 {return "";}

◆ prefixWarning()

std::string DGtal::TraceWriterFile::prefixWarning ( )
inlinevirtual

Create a Warning Prefix

Returns
the prefix

Implements DGtal::TraceWriter.

Definition at line 97 of file TraceWriterFile.h.

97 {return "[WRG]";}

◆ selfDisplay()

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

Writes/Displays the object on an output stream.

Parameters
outthe output stream where the object is written.

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