Public Member Functions | Private Member Functions

DGtal::TraceWriterTerm Class Reference

#include <TraceWriterTerm.h>

Inheritance diagram for DGtal::TraceWriterTerm:
Inheritance graph
[legend]
Collaboration diagram for DGtal::TraceWriterTerm:
Collaboration graph
[legend]

Public Member Functions

 TraceWriterTerm (std::ostream &aoutputStream=std::cerr)
 ~TraceWriterTerm ()
void selfDisplay (std::ostream &out) const
bool isValid () const
std::string prefixWarning ()
std::string prefixInfo ()
std::string prefixError ()
std::string prefixEmphase ()
std::string postfixReset ()

Private Member Functions

 TraceWriterTerm (const TraceWriterTerm &other)
TraceWriterTermoperator= (const TraceWriterTerm &other)

Detailed Description

Description of class 'TraceWriterTerm'

Aim: Implements trace prefix for color terminals

Todo:
Detect if the terminal has color capabilities

Constructor & Destructor Documentation

DGtal::TraceWriterTerm::TraceWriterTerm ( std::ostream &  aoutputStream = std::cerr  )  [inline]

Constructor.

Parameters:
outputStream the current output Stream
DGtal::TraceWriterTerm::~TraceWriterTerm (  )  [inline]

Destructor.

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

Copy constructor.

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

Member Function Documentation

bool DGtal::TraceWriterTerm::isValid (  )  const

Checks the validity/consistency of the object.

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

Reimplemented from DGtal::TraceWriter.

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

Assignment.

Parameters:
other the object to copy.
Returns:
a reference on 'this'. Forbidden by default.
std::string DGtal::TraceWriterTerm::postfixReset (  )  [inline, virtual]

Create a Reset postfix

Returns:
the postfix

Implements DGtal::TraceWriter.

std::string DGtal::TraceWriterTerm::prefixEmphase (  )  [inline, virtual]

Create an Emphase Prefix

Returns:
the prefix

Implements DGtal::TraceWriter.

std::string DGtal::TraceWriterTerm::prefixError (  )  [inline, virtual]

Create an Error Prefix

Returns:
the prefix

Implements DGtal::TraceWriter.

std::string DGtal::TraceWriterTerm::prefixInfo (  )  [inline, virtual]

Create an Info Prefix

Returns:
the prefix

Implements DGtal::TraceWriter.

std::string DGtal::TraceWriterTerm::prefixWarning (  )  [inline, virtual]

Create a Wrarning Prefix

Returns:
the prefix

Implements DGtal::TraceWriter.

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

Writes/Displays the object on an output stream.

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

Reimplemented from DGtal::TraceWriter.


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