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 CFileInputStream_H 00029 #define CFileInputStream_H 00030 00031 #include <mrpt/utils/CStream.h> 00032 00033 #include <iostream> 00034 00035 /*--------------------------------------------------------------- 00036 Class 00037 ---------------------------------------------------------------*/ 00038 namespace mrpt 00039 { 00040 namespace utils 00041 { 00042 /** This CStream derived class allow using a file as a read-only, binary stream. 00043 * 00044 * \sa CStream, CFileStream, CFileGZInputStream 00045 */ 00046 class MRPTDLLIMPEXP CFileInputStream : public CStream, public CUncopiable 00047 { 00048 protected: 00049 /** Method responsible for reading from the stream. 00050 */ 00051 size_t Read(void *Buffer, size_t Count); 00052 00053 /** Method responsible for writing to the stream. 00054 * Write attempts to write up to Count bytes to Buffer, and returns the number of bytes actually written. 00055 */ 00056 size_t Write(const void *Buffer, size_t Count); 00057 00058 private: 00059 std::ifstream m_if; //!< The actual input file stream. 00060 00061 DECLARE_UNCOPIABLE( CFileInputStream ) 00062 00063 public: 00064 /** Constructor 00065 * \param fileName The file to be open in this stream 00066 * \exception std::exception On error trying to open the file. 00067 */ 00068 CFileInputStream(const std::string &fileName ); 00069 00070 /** Default constructor 00071 */ 00072 CFileInputStream(); 00073 00074 /** Open a file for reading 00075 * \param fileName The file to be open in this stream 00076 * \return true on success. 00077 */ 00078 bool open(const std::string &fileName ); 00079 00080 /** Close the stream. */ 00081 void close(); 00082 00083 /** Destructor 00084 */ 00085 virtual ~CFileInputStream(); 00086 00087 /** Says if file was open successfully or not. 00088 */ 00089 bool fileOpenCorrectly(); 00090 00091 /** Will be true if EOF has been already reached. 00092 */ 00093 bool checkEOF(); 00094 00095 /** Method for moving to a specified position in the streamed resource. 00096 * See documentation of CStream::Seek 00097 */ 00098 size_t Seek(long Offset, CStream::TSeekOrigin Origin = sFromBeginning); 00099 00100 /** Method for getting the total number of bytes in the buffer. 00101 */ 00102 size_t getTotalBytesCount(); 00103 00104 /** Method for getting the current cursor position, where 0 is the first byte and TotalBytesCount-1 the last one. 00105 */ 00106 size_t getPosition(); 00107 00108 /** Reads one string line from the file (until a new-line character) 00109 * \return true if a line has been read, false on EOF or error. 00110 */ 00111 bool readLine( std::string &str ); 00112 00113 }; // End of class def. 00114 00115 } // End of namespace 00116 } // end of namespace 00117 #endif
Page generated by Doxygen 1.5.9 for MRPT 0.7.1 SVN: at Mon Aug 17 22:21:34 EDT 2009 |