OpenWalnut
1.4.0
|
00001 //--------------------------------------------------------------------------- 00002 // 00003 // Project: OpenWalnut ( http://www.openwalnut.org ) 00004 // 00005 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS 00006 // For more information see http://www.openwalnut.org/copying 00007 // 00008 // This file is part of OpenWalnut. 00009 // 00010 // OpenWalnut is free software: you can redistribute it and/or modify 00011 // it under the terms of the GNU Lesser General Public License as published by 00012 // the Free Software Foundation, either version 3 of the License, or 00013 // (at your option) any later version. 00014 // 00015 // OpenWalnut is distributed in the hope that it will be useful, 00016 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00018 // GNU Lesser General Public License for more details. 00019 // 00020 // You should have received a copy of the GNU Lesser General Public License 00021 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>. 00022 // 00023 //--------------------------------------------------------------------------- 00024 00025 #ifndef WREADER_H 00026 #define WREADER_H 00027 00028 #include <string> 00029 00030 #include "../exceptions/WDHNoSuchFile.h" 00031 #include "../../common/WDefines.h" 00032 00033 /** 00034 * Read some data from a given file. This base class is just for file 00035 * management (file exists, etc.) Subclasses may use those mechanisms and 00036 * specify their file format which is not the purpose of this base class. 00037 * \ingroup dataHandler 00038 */ 00039 class WReader 00040 { 00041 public: 00042 /** 00043 * Creates a read object for file reading. 00044 * 00045 * \param fname path to file which should be loaded 00046 * \throws WDHNoSuchFile 00047 */ 00048 explicit WReader( std::string fname ) throw( WDHNoSuchFile ); 00049 00050 /** 00051 * Reset the file name and checks if it exists. 00052 * 00053 * \param fname file name 00054 * \throws WDHNoSuchFile 00055 * \deprecated use setFilename instead. 00056 */ 00057 OW_API_DEPRECATED void setFileName( std::string fname ) throw( WDHNoSuchFile ); 00058 00059 /** 00060 * Reset the file name and checks if it exists. 00061 * 00062 * \param fname file name 00063 * \throws WDHNoSuchFile 00064 */ 00065 void setFilename( std::string fname ) throw( WDHNoSuchFile ); 00066 00067 protected: 00068 std::string m_fname; //!< Absolute path of the file to read from 00069 00070 private: 00071 }; 00072 00073 #endif // WREADER_H