AbstractPbmPlusFile.H

Go to the documentation of this file.

/*---------------------------------------------------------------------+
 | Library QgarLib, graphics analysis and recognition                  |
 | Copyright (C) 2002  Qgar Project, LORIA                             |
 |                                                                     |
 | This library is free software; you can redistribute it and/or       |
 | modify it under the terms of the GNU Lesser General Public          |
 | License version 2.1, as published by the Free Software Foundation.  |
 |                                                                     |
 | This library is distributed in the hope that it will be useful,     |
 | but WITHOUT ANY WARRANTY; without even the implied warranty of      |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                |
 | See the GNU Lesser General Public License for more details.         |
 |                                                                     |
 | The GNU Lesser General Public License is included in the file       |
 | LICENSE.LGPL, in the root directory of the Qgar packaging. See      |
 | http://www.gnu.org/licenses/lgpl.html for the terms of the licence. |
 | To receive a paper copy, write to the Free Software Foundation,     |
 | Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.       |
 |                                                                     |
 | Contact Project Qgar for any information:                           |
 |   LORIA - équipe Qgar                                               |
 |   B.P. 239, 54506 Vandoeuvre-lès-Nancy Cedex, France                |
 |   email: qgar-contact@loria.fr                                      |
 |   http://www.qgar.org/                                              |
 *---------------------------------------------------------------------*/


#ifndef __ABSTRACTPBMPLUS_H_INCLUDED__
#define __ABSTRACTPBMPLUS_H_INCLUDED__


/**
 * @file   AbstractPbmPlusFile.H
 * @brief  Header file of class qgar::AbstractPbmPlusFile.
 *
 * @author <a href="mailto:qgar-develop@loria.fr?subject=Qgar fwd Karl Tombre">Karl Tombre</a>
 * @date   Jul, 3  2001  16:25
 * @since  Qgar 1.0
 */

// For RCS/CVS use: Do not delete
/* $Id: AbstractPbmPlusFile.H,v 1.12 2005/07/13 16:29:00 masini Exp $ */



// QGAR
#include <qgarlib/AbstractFile.H>
#include <qgarlib/QgarErrorInvalidArg.H>
#include <qgarlib/QgarErrorIO.H>



namespace qgar
{


// TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT
// TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT
// T Y P E S   R E L A T E D   T O   P B M   F I L E S
// TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT
// TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT


/**
 * @name Types related to PBM files
 * @ingroup IO_FILE
 */
//@{

/**
 * @brief PBM+ file formats.
 */
enum QGEpbmFormat
{
QGE_PBM_PLAIN,
QGE_PBM_RAW
};

//@}


// TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT
// TTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTTT





/**
 * @class AbstractPbmPlusFile AbstractPbmPlusFile.H "qgarlib/AbstractPbmPlusFile.H"
 * @ingroup IO_FILE
 *
 * @brief File containing an image in some PBM+ format.
 * 
 * Most of the code documented here is an adaptation of code from the PBM
 * software package. Here is the copyright notice of this package:
@verbatim
 +------------------------------------------------------------------------+
 | Copyright (C) 1988 by Jef Poskanzer                                    |
 |                                                                        |
 | Permission to use, copy, modify, and distribute this software and its  |
 | documentation for any purpose and without fee is hereby granted,       |
 | provided that the above copyright notice appear in all copies and that |
 | both that copyright notice and this permission notice appear in        |
 | supporting documentation.  This software is provided "as is" without   |
 | express or implied warranty.                                           |
 +------------------------------------------------------------------------+
@endverbatim
 *  For more information about PBM, see the
 *  <a href="http://www.bath.ac.uk/BUCS/Software/graphics/pbm/pbm.html">PBMPLUS home page</a>.
 *
 * @warning This is an abstract class.
 * Pure virtual functions:
 * - qgar::AbstractPbmPlusFile::readRow
 * - qgar::AbstractPbmPlusFile::writeRow
 *
 * @author <a href="mailto:qgar-develop@loria.fr?subject=Qgar fwd Karl Tombre">Karl Tombre</a>
 * @date   Jul, 3  2001  16:25
 * @since  Qgar 1.0
 */
class AbstractPbmPlusFile

  : public AbstractFile

{
// -------------------------------------------------------------------
// P U B L I C    M E M B E R S
// -------------------------------------------------------------------
public:

  /** @name Destructor */
  //        ==========
  //@{

  /**
   * @brief Free the current row.
   */
  virtual ~AbstractPbmPlusFile();

  //@}


  /** @name Access */
  //        ======
  //@{

  /**
   * @brief Get number of columns.
   */
  inline int colCnt() const;

  /**
   * @brief Get number of rows.
   */
  inline int rowCnt() const;

  /**
   * @brief Get current row.
   */
  inline unsigned char* pRow();

  //@}


  /** @name Assignment */
  //        ==========
  //@{

  /**
   * @brief Set number of columns.
   *
   * @param aCnt  number to set
   */
  inline void setColCnt(int aCnt);

  /**
   * @brief Set number of rows.
   *
   * @param aCnt  number to set
   */
  inline void setRowCnt(int aCnt);

  //@}


  /** @name Input */
  //        =====
  //@{

  /**
   * @brief Read a row from the file.
   */
  virtual void readRow() = 0;

  //@}


  /** @name Output */
  //        ======
  //@{

  /**
   * @brief Write a row into the file.
   */
  virtual void writeRow() = 0;

  //@}

// -------------------------------------------------------------------
// P R O T E C T E D    M E M B E R S
// -------------------------------------------------------------------
protected:

  //  ============================================
  /** @name Constructors
      Constructors belong to the protected section
      so that the class cannot be instantiated.
   */
  //  ============================================
  //@{

  /**
   * @brief Initialize with full data.
   *
   * @param aFileName name of the new file
   * @param aRowCnt    number of rows of the corresponding image
   * @param aColCnt    number of columns of the corresponding image
   * @param aFormat   format of the image contained in the file (default raw)
   *
   * @exception qgar::QgarErrorInvalidArg (bad image size)
   */
  AbstractPbmPlusFile(const char*  aFileName,
                      int          aRowCnt,
                      int          aColCnt,
                      QGEpbmFormat aFormat = QGE_PBM_RAW)
    throw(QgarErrorInvalidArg);

  //@}


  /** @name Representation of a file */
  //        ========================
  //@{

  /**
   * @brief Format of the file.
   */
  QGEpbmFormat _format;

  /**
   * @brief Number of rows of the image.
   */
  int _rowCnt;

  /**
   * @brief Number of columns of the image.
   */
  int _colCnt;

  /**
   * @brief Pointer to current image row.
   */
  unsigned char* _pRow;

  //@}


  /** @name Input auxiliaries */
  //        =================
  //@{

  /**
   * @brief Read a character from the file. 
   *
   * @exception qgar::QgarErrorIO (EOF while reading in file)
  */
  virtual char getChar() throw(QgarErrorIO);

  /**
   * @brief Read an integer from the file. 
   *
   * @exception qgar::QgarErrorIO
   * (error while reading in file: integer in [0,9] expected)
   */
  virtual int getInt() throw(QgarErrorIO);

  /**
   * @brief Read a raw byte from the file. 
   *
   *  @exception qgar::QgarErrorIO (EOF while reading in file)
   */
  virtual unsigned char getRawByte() throw(QgarErrorIO);

  //@}


  /** @name Memory space allocation */
  //        =======================
  //@{

  /**
   * @brief Allocate a new row.
   */
  void newRow();

  //@}

// -------------------------------------------------------------------
}; // class AbstractPbmPlusFile




// IIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIII
// IIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIII
// I N L I N E   F U N C T I O N S   I M P L E M E N T A T I O N 
// IIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIII
// IIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIII


// ======
// ACCESS
// ======

// GET NUMBER OF COLUMNS

inline int
AbstractPbmPlusFile::colCnt() const
{
  return _colCnt;
}


// GET NUMBER OF ROWS

inline int
AbstractPbmPlusFile::rowCnt() const
{
  return _rowCnt;
}


// GET CURRENT ROW

inline unsigned char*
AbstractPbmPlusFile::pRow()
{
  return _pRow;
}


// ==========
// ASSIGNMENT
// ==========


// SET NUMBER OF COLUMNS

inline void
AbstractPbmPlusFile::setColCnt(int aCnt)
{
  _colCnt = aCnt;
}


// SET NUMBER OF ROWS

inline void
AbstractPbmPlusFile::setRowCnt(int aCnt)
{
  _rowCnt = aCnt;
}


// IIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIII
// IIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIII


} // namespace qgar


#endif /* __ABSTRACTPBMPLUS_H_INCLUDED__ */