Migration from SVN

eo/src/utils/eoFileMonitor.h

@@ -0,0 +1,121 @@
+// -*- mode: c++; c-indent-level: 4; c++-member-init-indent: 8; comment-column: 35; -*-
+
+//-----------------------------------------------------------------------------
+// eoFileMonitor.h
+// (c) Marc Schoenauer, Maarten Keijzer and GeNeura Team, 2000
+/*
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+    Contact: todos@geneura.ugr.es, http://geneura.ugr.es
+             Marc.Schoenauer@polytechnique.fr
+             mkeijzer@dhi.dk
+ */
+//-----------------------------------------------------------------------------
+
+#ifndef EO_eoFileMonitor_h
+#define EO_eoFileMonitor_h
+
+#include <string>
+#include <fstream>
+#include <stdexcept>
+
+#include "utils/eoMonitor.h"
+#include "eoObject.h"
+
+
+/** Prints statistics to file
+
+Modified the default behavior, so that it erases existing files. Can
+be modified in the ctor.
+
+@version MS 25/11/00
+@ingroup Monitors
+*/
+class eoFileMonitor : public eoMonitor
+{
+public :
+
+    /*! Constructor
+     *
+     * Try to create the file in writing mode, erasing it if asked.
+     *
+     * @param _filename complete filename to write to
+     * @param _delim delimiter string to use between each item of the registered vector (e.g. of eoStats)
+     * @param _keep_existing if true, overwrite any existing file with the same name prior to any output
+     * @param _header print the header (with the descriptions of registered eoStats) at the beginning of the file (WARNING: true will discards header printing)
+     * @param _overwrite if true, overwrite the existing file
+     */
+    eoFileMonitor(
+        std::string _filename,
+        std::string _delim = " ",
+        bool _keep_existing = false,
+        bool _header = false,
+        bool _overwrite = false
+        )
+        : filename(_filename),
+        delim(_delim),
+        keep(_keep_existing),
+        header(_header),
+        firstcall(true),
+        overwrite(_overwrite)
+    {
+        if (!_keep_existing) {
+            std::ofstream os (filename.c_str ());
+
+            if (!os) {
+                std::string str = "Error, eoFileMonitor could not open: " + filename;
+                throw std::runtime_error (str);
+            }
+        } // if ! keep
+    }
+
+    //! Called first, try to open the file in append mode and write the header if asked
+    virtual eoMonitor& operator()(void);
+
+    /*! Main call, normally called at each generation.
+    Write the content of the registered vector into the file, each item being separated by delim
+    */
+    virtual eoMonitor& operator()(std::ostream& os);
+
+    //! Try to open the file, and then call printHeader(file)
+    void printHeader(void);
+
+    //! Print long names of the registered items, separated by delim.
+    virtual void printHeader(std::ostream& os);
+
+    virtual std::string getFileName() { return filename;}
+
+private :
+
+    //! complete filename to write to
+    std::string filename;
+
+    //! delimiter to use between each write
+    std::string delim;
+
+    //! should we append or create a new file
+    bool keep;
+
+    //! printing header at begin of file?
+    bool header;
+
+    //! flag to avoid calling twice operator()(void)
+    bool firstcall;
+
+    //! erase the entire file prior to writing in it (mode eos_base::
+    bool overwrite;
+};
+
+#endif