Public Member Functions | Protected Member Functions | Private Member Functions

DGtal::Common Class Reference

#include <Common.h>

Public Member Functions

 ~Common ()
void selfDisplay (std::ostream &out) const
bool isValid () const

Protected Member Functions

 Common ()

Private Member Functions

 Common (const Common &other)
Commonoperator= (const Common &other)

Detailed Description

Description of class 'Common'

Aim: Holds the current configuration.


Constructor & Destructor Documentation

DGtal::Common::~Common (  ) 

Destructor.

DGtal::Common::Common (  )  [protected]

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

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

Copy constructor.

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

Member Function Documentation

bool DGtal::Common::isValid (  )  const

Checks the validity/consistency of the object.

Returns:
'true' if the object is valid, 'false' otherwise.
Common& DGtal::Common::operator= ( const Common other  )  [private]

Assignment.

Parameters:
other the object to copy.
Returns:
a reference on 'this'. Forbidden by default.
void DGtal::Common::selfDisplay ( std::ostream &  out  )  const

Writes/Displays the object on an output stream.

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

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