00001 /* +---------------------------------------------------------------------------+ 00002 | The Mobile Robot Programming Toolkit (MRPT) C++ library | 00003 | | 00004 | http://mrpt.sourceforge.net/ | 00005 | | 00006 | Copyright (C) 2005-2009 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 CFileGZOutputStream_H 00029 #define CFileGZOutputStream_H 00030 00031 #include <mrpt/utils/CStream.h> 00032 00033 /*--------------------------------------------------------------- 00034 Class 00035 ---------------------------------------------------------------*/ 00036 namespace mrpt 00037 { 00038 namespace utils 00039 { 00040 /** Saves data to a file and transparently compress the data using the given compression level. 00041 * The generated files are in gzip format ("file.gz"). 00042 * This class requires compiling MRPT with wxWidgets. If wxWidgets is not available then the class is actually mapped to the standard CFileOutputStream 00043 * 00044 * \sa CFileOutputStream 00045 */ 00046 #if !MRPT_HAS_GZ_STREAMS 00047 // We don't have wxwidgets: 00048 # define CFileGZOutputStream CFileOutputStream 00049 #else 00050 class MRPTDLLIMPEXP CFileGZOutputStream : public CStream, public CUncopiable 00051 { 00052 protected: 00053 /** Method responsible for reading from the stream. 00054 */ 00055 size_t Read(void *Buffer, size_t Count); 00056 00057 /** Method responsible for writing to the stream. 00058 * Write attempts to write up to Count bytes to Buffer, and returns the number of bytes actually written. 00059 */ 00060 size_t Write(const void *Buffer, size_t Count); 00061 00062 DECLARE_UNCOPIABLE( CFileGZOutputStream ) 00063 00064 private: 00065 void *m_f; 00066 00067 public: 00068 /** Constructor: opens an output file with compression level = 1 (minimum, fastest). 00069 * \param fileName The file to be open in this stream 00070 * \sa open 00071 */ 00072 CFileGZOutputStream(const std::string &fileName); 00073 00074 /** Constructor, without opening the file. 00075 * \sa open 00076 */ 00077 CFileGZOutputStream(); 00078 00079 /** Open a file for write, choosing the compression level 00080 * \param fileName The file to be open in this stream 00081 * \param compress_level 0:no compression, 1:fastest, 9:best 00082 * \return true on success, false on any error. 00083 */ 00084 bool open(const std::string &fileName, int compress_level = 1 ); 00085 00086 /** Close the file. */ 00087 void close(); 00088 00089 /** Destructor 00090 */ 00091 virtual ~CFileGZOutputStream(); 00092 00093 /** Says if file was open successfully or not. 00094 */ 00095 bool fileOpenCorrectly(); 00096 00097 /** Method for getting the current cursor position, where 0 is the first byte and TotalBytesCount-1 the last one. 00098 */ 00099 size_t getPosition(); 00100 00101 /** This method is not implemented in this class */ 00102 size_t Seek(long Offset, CStream::TSeekOrigin Origin = sFromBeginning) 00103 { 00104 THROW_EXCEPTION("Seek is not implemented in this class"); 00105 } 00106 00107 /** This method is not implemented in this class */ 00108 size_t getTotalBytesCount() 00109 { 00110 THROW_EXCEPTION("getTotalBytesCount is not implemented in this class"); 00111 } 00112 00113 }; // End of class def. 00114 #endif 00115 00116 } // End of namespace 00117 } // end of namespace 00118 #endif
Page generated by Doxygen 1.5.9 for MRPT 0.7.1 SVN: at Mon Aug 17 22:32:05 EDT 2009 |