Main MRPT website > C++ reference
MRPT logo

CFileGZInputStream.h

Go to the documentation of this file.
00001 /* +---------------------------------------------------------------------------+
00002    |          The Mobile Robot Programming Toolkit (MRPT) C++ library          |
00003    |                                                                           |
00004    |                   http://mrpt.sourceforge.net/                            |
00005    |                                                                           |
00006    |   Copyright (C) 2005-2011  University of Malaga                           |
00007    |                                                                           |
00008    |    This software was written by the Machine Perception and Intelligent    |
00009    |      Robotics Lab, University of Malaga (Spain).                          |
00010    |    Contact: Jose-Luis Blanco  <jlblanco@ctima.uma.es>                     |
00011    |                                                                           |
00012    |  This file is part of the MRPT project.                                   |
00013    |                                                                           |
00014    |     MRPT is free software: you can redistribute it and/or modify          |
00015    |     it under the terms of the GNU General Public License as published by  |
00016    |     the Free Software Foundation, either version 3 of the License, or     |
00017    |     (at your option) any later version.                                   |
00018    |                                                                           |
00019    |   MRPT is distributed in the hope that it will be useful,                 |
00020    |     but WITHOUT ANY WARRANTY; without even the implied warranty of        |
00021    |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         |
00022    |     GNU General Public License for more details.                          |
00023    |                                                                           |
00024    |     You should have received a copy of the GNU General Public License     |
00025    |     along with MRPT.  If not, see <http://www.gnu.org/licenses/>.         |
00026    |                                                                           |
00027    +---------------------------------------------------------------------------+ */
00028 #ifndef  CFileGZInputStream_H
00029 #define  CFileGZInputStream_H
00030 
00031 #include <mrpt/utils/CStream.h>
00032 
00033 #include <iostream>
00034 
00035 
00036 /*---------------------------------------------------------------
00037         Class
00038   ---------------------------------------------------------------*/
00039 namespace mrpt
00040 {
00041         namespace utils
00042         {
00043                 /** Transparently opens a compressed "gz" file and reads uncompressed data from it.
00044                  *   If the file is not a .gz file, it silently reads data from the file.
00045                  *  This class requires compiling MRPT with wxWidgets. If wxWidgets is not available then the class is actually mapped to the standard CFileInputStream
00046                  *
00047                  * \sa CFileInputStream
00048                  */
00049                 class BASE_IMPEXP CFileGZInputStream : public CStream, public CUncopiable
00050                 {
00051                 protected:
00052                          /** Method responsible for reading from the stream.
00053                          */
00054                         size_t  Read(void *Buffer, size_t Count);
00055 
00056                         /** Method responsible for writing to the stream.
00057                          *  Write attempts to write up to Count bytes to Buffer, and returns the number of bytes actually written.
00058                          */
00059                         size_t  Write(const void *Buffer, size_t Count);
00060 
00061                         // DECLARE_UNCOPIABLE( CFileGZInputStream )
00062 
00063                 private:
00064                         void            *m_f;
00065                         uint64_t        m_file_size;    //!< Compressed file size
00066 
00067                 public:
00068                          /** Constructor without open
00069                           */
00070                         CFileGZInputStream();
00071 
00072                          /** Constructor and open
00073                           * \param fileName The file to be open in this stream
00074                           * \exception std::exception If there's an error opening the file.
00075                           */
00076                         CFileGZInputStream(const std::string &fileName );
00077 
00078                          /** Destructor
00079                          */
00080                          virtual ~CFileGZInputStream();
00081 
00082                          /** Opens the file for read.
00083                           * \param fileName The file to be open in this stream
00084                           * \return false if there's an error opening the file, true otherwise
00085                           */
00086                          bool open(const std::string &fileName );
00087 
00088                          /** Closes the file */
00089                          void close();
00090 
00091                          /** Says if file was open successfully or not.
00092                           */
00093                          bool  fileOpenCorrectly();
00094 
00095                          /** Will be true if EOF has been already reached.
00096                            */
00097                          bool checkEOF();
00098 
00099                         /** Method for getting the total number of <b>compressed</b> bytes of in the file (the physical size of the compressed file).
00100                          */
00101                         uint64_t getTotalBytesCount();
00102 
00103                         /** Method for getting the current cursor position in the <b>compressed</b>, where 0 is the first byte and TotalBytesCount-1 the last one.
00104                          */
00105                         uint64_t getPosition();
00106 
00107                         /** This method is not implemented in this class */
00108                         uint64_t Seek(long Offset, CStream::TSeekOrigin Origin = sFromBeginning)
00109                         {
00110                                 THROW_EXCEPTION("Seek is not implemented in this class");
00111                         }
00112 
00113                 }; // End of class def.
00114 
00115         } // End of namespace
00116 } // end of namespace
00117 #endif



Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:40:17 UTC 2011