CFileGZOutputStream.h

Go to the documentation of this file.

/* +---------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)               |
   |                          http://www.mrpt.org/                             |
   |                                                                           |
   | Copyright (c) 2005-2017, Individual contributors, see AUTHORS file        |
   | See: http://www.mrpt.org/Authors - All rights reserved.                   |
   | Released under BSD License. See details in http://www.mrpt.org/License    |
   +---------------------------------------------------------------------------+ */
#ifndef  CFileGZOutputStream_H
#define  CFileGZOutputStream_H

#include <mrpt/utils/CStream.h>

namespace mrpt
{
        namespace utils
        {
                /** Saves data to a file and transparently compress the data using the given compression level.
                 *   The generated files are in gzip format ("file.gz").
                 *  This class requires compiling MRPT with wxWidgets. If wxWidgets is not available then the class is actually mapped to the standard CFileOutputStream
                 *
                 * \sa CFileOutputStream
                 * \ingroup mrpt_base_grp
                 */
#if !MRPT_HAS_GZ_STREAMS
                // We don't have wxwidgets:
#       define CFileGZOutputStream      CFileOutputStream
#else
                class BASE_IMPEXP CFileGZOutputStream : public CStream, public CUncopiable
                {
                protected:
                        size_t  Read(void *Buffer, size_t Count) MRPT_OVERRIDE;
                        size_t  Write(const void *Buffer, size_t Count) MRPT_OVERRIDE;
                        // DECLARE_UNCOPIABLE( CFileGZOutputStream )
                private:
                        void            *m_f;
                public:
                         /** Constructor: opens an output file with compression level = 1 (minimum, fastest).
                          * \param fileName The file to be open in this stream
                          * \sa open
                          */
                        CFileGZOutputStream(const std::string &fileName);

                        /** Constructor, without opening the file.
                          * \sa open
                          */
                        CFileGZOutputStream();
                        virtual ~CFileGZOutputStream(); //!< Destructor

                         /** Open a file for write, choosing the compression level
                          * \param fileName The file to be open in this stream
                          * \param compress_level 0:no compression, 1:fastest, 9:best
                          * \return true on success, false on any error.
                          */
                        bool open(const std::string &fileName, int compress_level = 1 );
                        void close(); //!< Close the file
                        bool fileOpenCorrectly(); //!< Returns true if the file was open without errors.
                        bool is_open() { return fileOpenCorrectly(); } //!< Returns true if the file was open without errors.
                        uint64_t getPosition()  MRPT_OVERRIDE; //!< Method for getting the current cursor position, where 0 is the first byte and TotalBytesCount-1 the last one.

                        /** This method is not implemented in this class */
                        uint64_t Seek(int64_t Offset, CStream::TSeekOrigin Origin = sFromBeginning)  MRPT_OVERRIDE
                        {
                                MRPT_UNUSED_PARAM(Offset); MRPT_UNUSED_PARAM(Origin);
                                THROW_EXCEPTION("Seek is not implemented in this class");
                        }

                        /** This method is not implemented in this class */
                        uint64_t getTotalBytesCount()  MRPT_OVERRIDE
                        {
                                THROW_EXCEPTION("getTotalBytesCount is not implemented in this class");
                        }
                }; // End of class def.
#endif

        } // End of namespace
} // end of namespace
#endif