OpenWalnut  1.2.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
WRoiProjectFileIO.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 WROIPROJECTFILEIO_H
26 #define WROIPROJECTFILEIO_H
27 
28 #include <string>
29 
30 #include "../common/WProjectFileIO.h"
31 
32 #include "WExportKernel.h"
33 
34 /**
35  * IO Class for writing the ROI structure to a project file.
36  */
37 class OWKERNEL_EXPORT WRoiProjectFileIO: public WProjectFileIO
38 {
39 public:
40 
41  /**
42  * Default constructor.
43  */
45 
46  /**
47  * Destructor.
48  */
49  virtual ~WRoiProjectFileIO();
50 
51  /**
52  * This method parses the specified line and interprets it. It gets called line by line by WProjectFile.
53  *
54  * \param line the current line as string
55  * \param lineNumber the current line number. Useful for error/warning/debugging output.
56  *
57  * \return true if the line could be parsed.
58  */
59  virtual bool parse( std::string line, unsigned int lineNumber );
60 
61  /**
62  * Called whenever the end of the project file has been reached. This is useful if your specific parser class wants to do some post
63  * processing after parsing line by line.
64  */
65  virtual void done();
66 
67  /**
68  * Saves the state to the specified stream.
69  *
70  * \param output the stream to print the state to.
71  */
72  virtual void save( std::ostream& output ); // NOLINT
73 
74 protected:
75 
76 private:
77 };
78 
79 #endif // WROIPROJECTFILEIO_H
80