OpenWalnut  1.2.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
WWriter.h
1 //---------------------------------------------------------------------------
2 //
3 // Project: OpenWalnut ( http://www.openwalnut.org )
4 //
5 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
6 // For more information see http://www.openwalnut.org/copying
7 //
8 // This file is part of OpenWalnut.
9 //
10 // OpenWalnut is free software: you can redistribute it and/or modify
11 // it under the terms of the GNU Lesser General Public License as published by
12 // the Free Software Foundation, either version 3 of the License, or
13 // (at your option) any later version.
14 //
15 // OpenWalnut is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU Lesser General Public License for more details.
19 //
20 // You should have received a copy of the GNU Lesser General Public License
21 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
22 //
23 //---------------------------------------------------------------------------
24 
25 #ifndef WWRITER_H
26 #define WWRITER_H
27 
28 #include <string>
29 
30 #include "../WExportDataHandler.h"
31 
32 /**
33  * Write some data to the given file. This base class is just for file
34  * management (file exists, etc.) Subclasses may use those mechanisms and
35  * specify their file format which is not the purpose of this base class.
36  */
38 {
39 public:
40  /**
41  * Creates a writer object for writing something to a file. Use the flags
42  * to specify the behaviour.
43  *
44  * \param fname path to the target file where stuff will be written to
45  * \param overwrite If true existing files will be overwritten
46  */
47  WWriter( std::string fname, bool overwrite = false );
48 
49  /**
50  * Reset file name and checks if the file already exists in case of
51  * non overwriting is specified.
52  *
53  * \param fname file name
54  */
55  void setFileName( std::string fname );
56 
57 protected:
58  std::string m_fname; //!< Absolute path of the file to write to
59  bool m_overwrite; //!< flag indicating if the file may be overwritten (true) or not (false)
60 
61 private:
62 };
63 
64 #endif // WWRITER_H