source: trunk/lib/GnuplotFE.h @ 97

// $Id: GnuplotFE.h 97 2006-04-01 21:33:44Z jari $

/*
  Copyright (C) 2006 Jari Häkkinen, Peter Johansson

  This file is part of svnstat, http://lev.thep.lu.se/trac/svnstat

  svnstat is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  svnstat 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
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/

#ifndef _theplu_svnstat_gnuplotfe_
#define _theplu_svnstat_gnuplotfe_

#include "Gnuplot.h"
#include <string>
#include <vector>


namespace theplu {
namespace svnstat {

  ///
  /// The GnuplotFE class is a front end to the Gnuplot class. This is
  /// a utility function needed to communicate plotting related
  /// information between objects.
  ///
  /// GnuplotFE provides one single global access point to the
  /// underlying gnuplot binary and makes sure that there is only one
  /// point of access to the binary.
  ///
  /// @see Design Patterns (the singleton pattern).
  ///
  class GnuplotFE : public Gnuplot
  {
  public:
    ///
    /// The destructor.
    ///
    ~GnuplotFE(void) { delete instance_; }

    ///
    /// @return input format for date.
    ///
    // Peter, obsolete ?
    const std::string& date_input_format(void) { return date_input_format_; }

    ///
    ///
    ///
    void plot(const std::vector<u_int>& y,const std::string& format="%y-%b");

    ///
    ///
    ///
    void replot(const std::vector<u_int>& y);

    ///
    /// @throw Re-throws a GnuplotException from Gnuplot.
    ///
    static GnuplotFE* instance(void)
    { if (!instance_) instance_=new GnuplotFE; return instance_; }

    ///
    /// sets format of date output.
    ///
    inline void set_date_format(const std::string& format)
    { date_output_format_ = format;}

    ///
    /// Function setting the dates. \a format must comply with strings
    /// in date.
    ///
    inline void set_dates(const std::vector<std::string>& date,
                          const std::string& format="%Y-%m-%d")
    { date_=date; date_input_format_=format; }

    ///
    /// Set the upper value for the y axis, the lower values is always
    /// zero. Call this function with an argument 0 (or without an
    /// argument) to cancel the current setting. Negative argument
    /// values are treated as zero value.
    ///
    /// @return Returns the actual set upper value. A zero value is
    /// returned if the current setting was cancelled.
    ///
    /// @see Gnuplot documentation for yrange
    ///
    double yrange(double ymax=0.0);

  private:
    ///
    /// @throw Re-throws a GnuplotException from Gnuplot.
    ///
    GnuplotFE(void) {};

    ///
    /// Copy constructor, not implemented.
    ///
    GnuplotFE(const GnuplotFE&);

    std::vector<std::string> date_;
    std::string date_input_format_;
    std::string date_output_format_;
    static GnuplotFE* instance_;
};

}} // end of namespace svnstat and namespace theplu

#endif