OpenWalnut  1.4.0
WWriterDendrogram.h
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 WWRITERDENDROGRAM_H
00026 #define WWRITERDENDROGRAM_H
00027 
00028 #include <string>
00029 
00030 #include <boost/filesystem.hpp>
00031 #include <boost/shared_ptr.hpp>
00032 
00033 
00034 #include "WWriter.h"
00035 
00036 class WDendrogram;
00037 /**
00038  * Writes a Dendrogram file.
00039  */
00040 class WWriterDendrogram : public WWriter // NOLINT
00041 {
00042 public:
00043     /**
00044      * Creates a writer object for Dendrogram file writing.
00045      *
00046      * \param path to the target file where stuff will be written to
00047      * \param overwrite If true existing files will be overwritten
00048      */
00049     WWriterDendrogram( const boost::filesystem::path& path, bool overwrite = false );
00050 
00051     /**
00052      * Writes finaly the given dendrogram to the previously specified file.
00053      *
00054      * \param dendrogram The dendrogram to save
00055      */
00056     void write( boost::shared_ptr< const WDendrogram > dendrogram ) const;
00057 
00058 protected:
00059 private:
00060 };
00061 
00062 #endif  // WWRITERDENDROGRAM_H