OpenWalnut  1.4.0
WWriterDendrogram.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 WWRITERDENDROGRAM_H
26 #define WWRITERDENDROGRAM_H
27 
28 #include <string>
29 
30 #ifndef Q_MOC_RUN
31 #include <boost/filesystem.hpp>
32 #endif
33 #ifndef Q_MOC_RUN
34 #include <boost/shared_ptr.hpp>
35 #endif
36 
37 
38 #include "WWriter.h"
39 
40 class WDendrogram;
41 /**
42  * Writes a Dendrogram file.
43  */
44 class WWriterDendrogram : public WWriter // NOLINT
45 {
46 public:
47  /**
48  * Creates a writer object for Dendrogram file writing.
49  *
50  * \param path to the target file where stuff will be written to
51  * \param overwrite If true existing files will be overwritten
52  */
53  WWriterDendrogram( const boost::filesystem::path& path, bool overwrite = false );
54 
55  /**
56  * Writes finaly the given dendrogram to the previously specified file.
57  *
58  * \param dendrogram The dendrogram to save
59  */
60  void write( boost::shared_ptr< const WDendrogram > dendrogram ) const;
61 
62 protected:
63 private:
64 };
65 
66 #endif // WWRITERDENDROGRAM_H
void write(boost::shared_ptr< const WDendrogram > dendrogram) const
Writes finaly the given dendrogram to the previously specified file.
Write some data to the given file.
Definition: WWriter.h:37
Writes a Dendrogram file.
WWriterDendrogram(const boost::filesystem::path &path, bool overwrite=false)
Creates a writer object for Dendrogram file writing.
Hirachical binary tree datastructure with spatial layout information called dendrogram.
Definition: WDendrogram.h:64