CFileOutputStream.h

Go to the documentation of this file.

/* +---------------------------------------------------------------------------+
   |          The Mobile Robot Programming Toolkit (MRPT) C++ library          |
   |                                                                           |
   |                       http://www.mrpt.org/                                |
   |                                                                           |
   |   Copyright (C) 2005-2012  University of Malaga                           |
   |                                                                           |
   |    This software was written by the Machine Perception and Intelligent    |
   |      Robotics Lab, University of Malaga (Spain).                          |
   |    Contact: Jose-Luis Blanco  <jlblanco@ctima.uma.es>                     |
   |                                                                           |
   |  This file is part of the MRPT project.                                   |
   |                                                                           |
   |     MRPT is free software: you can redistribute it and/or modify          |
   |     it under the terms of the GNU General Public License as published by  |
   |     the Free Software Foundation, either version 3 of the License, or     |
   |     (at your option) any later version.                                   |
   |                                                                           |
   |   MRPT 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 General Public License for more details.                          |
   |                                                                           |
   |     You should have received a copy of the GNU General Public License     |
   |     along with MRPT.  If not, see <http://www.gnu.org/licenses/>.         |
   |                                                                           |
   +---------------------------------------------------------------------------+ */
#ifndef  CFileOutputStream_H
#define  CFileOutputStream_H

#include <mrpt/utils/CStream.h>

#include <iostream>

/*---------------------------------------------------------------
        Class
  ---------------------------------------------------------------*/
namespace mrpt
{
namespace utils
{
        /** This CStream derived class allow using a file as a write-only, binary stream.
         *
         * \sa CStream, CFileStream, CFileGZOutputStream
         * \ingroup mrpt_base_grp
         */
        class BASE_IMPEXP CFileOutputStream : public CStream, public CUncopiable
        {
        protected:
                 /** Method responsible for reading from the stream.
                 */
                size_t  Read(void *Buffer, size_t Count);

                /** Method responsible for writing to the stream.
                 *  Write attempts to write up to Count bytes to Buffer, and returns the number of bytes actually written.
                 */
                size_t  Write(const void *Buffer, size_t Count);

                // DECLARE_UNCOPIABLE( CFileOutputStream )

        private:
                std::ofstream   m_of;           //!< The actual output file stream.

        public:
                 /** Constructor
                  * \param fileName The file to be open in this stream
                  * \param append If set to true, the file will be opened for writing and the current cursor position set at the end of the file. Otherwise, previous contents will be lost.
                  * \exception std::exception if the file cannot be opened.
                  */
                CFileOutputStream(
                        const std::string &fileName,
                        bool  append = false
                         );

                 /** Default constructor
                  */
                CFileOutputStream();

                 /** Open the given file for write
                  * \param fileName The file to be open in this stream
                  * \param append If set to true, the file will be opened for writing and the current cursor position set at the end of the file. Otherwise, previous contents will be lost.
                  * \sa fileOpenCorrectly
                  * \return true on success.
                  */
                bool open(const std::string &fileName, bool  append = false );

                /** Close the stream. */
                void close();

                 /** Destructor
                 */
                 virtual ~CFileOutputStream();

                 /** Says if file was open successfully or not.
                  */
                 bool  fileOpenCorrectly();

                /** Method for moving to a specified position in the streamed resource.
                 *   See documentation of CStream::Seek
                 */
                uint64_t Seek(long Offset, CStream::TSeekOrigin Origin = sFromBeginning);

                /** Method for getting the total number of bytes writen to buffer.
                 */
                uint64_t getTotalBytesCount();

                /** Method for getting the current cursor position, where 0 is the first byte and TotalBytesCount-1 the last one.
                 */
                uint64_t getPosition();


        }; // End of class def.

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