source: branches/0.8-stable/lib/Graph.h @ 1199

Last change on this file since 1199 was 1017, checked in by Peter Johansson, 11 years ago

updating copyright years

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 4.0 KB
Line 
1#ifndef _theplu_svndigest_graph_
2#define _theplu_svndigest_graph_
3
4// $Id: Graph.h 1017 2010-01-09 14:41:34Z peter $
5
6/*
7  Copyright (C) 2009 Jari Häkkinen, Peter Johansson
8  Copyright (C) 2010 Peter Johansson
9
10  This file is part of svndigest, http://dev.thep.lu.se/svndigest
11
12  svndigest is free software; you can redistribute it and/or modify it
13  under the terms of the GNU General Public License as published by
14  the Free Software Foundation; either version 3 of the License, or
15  (at your option) any later version.
16
17  svndigest is distributed in the hope that it will be useful, but
18  WITHOUT ANY WARRANTY; without even the implied warranty of
19  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20  General Public License for more details.
21
22  You should have received a copy of the GNU General Public License
23  along with svndigest. If not, see <http://www.gnu.org/licenses/>.
24*/
25
26#include <config.h>
27
28#include <string>
29#include <vector>
30
31#ifdef HAVE_PLPLOT
32#include <plplot/plstream.h>
33#else
34typedef int PLINT;
35typedef double PLFLT;
36typedef double plstream;
37#endif
38
39namespace theplu {
40namespace svndigest {
41
42  /**
43     Graph is used to generate plots in svndigest and is a specialized
44     wrapper to the plplot plot library, http://plplot.sourceforge.net/
45
46     Graph allows some axis label manipulation, setting pen colour,
47     and plotting lines.
48
49     Graph supports three graphics formats - portable network graphics
50     (png), scalable vector graphics (svg), and protable document
51     format (pdf) - if the underlying plplot library was built with
52     the appropriate modules. If not, rebuild and reinstall plplot.
53  */
54  class Graph
55  {
56  public:
57
58    /**
59       \brief Constructor
60
61       \a filename to be defined depending on whether we'll support
62       more output formats than SVG.
63
64       \note The plot legend is created in the destructioe, i.e., when
65       the graph object is destroyed.
66    */
67    Graph(const std::string& filename, const std::string& format);
68
69    /**
70       \brief Destructor
71    */
72    ~Graph(void);
73
74    /**
75       \brief Set the pen colour to use in next drawing call
76    */
77    void current_color(unsigned char r, unsigned char g, unsigned char b);
78
79    static bool date_xticks(void);
80
81    /**
82       \brief Plot \a data and use \a lines and \a label to compose
83       the legend label.
84
85       The legend will be a coloured line followed by \a lines
86       followed by \a label.
87
88       The label order in the legend is reverse to the plot order,
89       i.e., the last plotted line will get the top entry in the
90       legend, the second to last plotted line will be the second
91       legend entry, and so on.
92    */
93    void plot(const std::vector<unsigned int>& data, const std::string& label,
94              unsigned int lines);
95
96    /**
97       \brief Function setting the dates.
98
99       The date strings must be in svn format since underlying time
100       conversion are done with the Date class.
101
102       \see Date::svntime(std::string)
103    */
104    static void set_dates(const std::vector<std::string>& date);
105
106    /**
107       \brief Set x-axis tick value format to \a format. The format is
108       only used when dates are used.
109    */
110    void timeformat(const std::string& format);
111
112    static const std::vector<std::string>& xticks(void);
113
114    /**
115       \brief Set max y value in the plot
116
117       The plot area is (xstart,0) to (xend,\a ymax) where xend is
118       either the length of vector to plot (corresponds to latest
119       revision number) or the date of the last revision commit,
120       xstart is 0 or the date of the first commit.
121    */
122    double ymax(double ymax);
123
124  private:
125
126    // Copy constructor not implemented
127    Graph(const Graph&);
128
129    struct legend_data {
130      std::string label;
131      unsigned int lines;
132      PLINT r,g,b;
133    };
134
135    /**
136       \brief Set the pen colour to use in next drawing call
137    */
138    void current_color(const legend_data&);
139    void print_legend(void);
140    unsigned int tick_spacing(const double range) const;
141
142    std::vector<legend_data> legend_;
143    unsigned int plots_; // keep track of number of plots drawn
144    plstream pls_;
145    std::string timeformat_;
146    std::string title_;
147    static std::vector<std::string> xticks_;
148    PLFLT xmin_, xmax_, xrange_, ymin_, ymax_, yrange_;
149  };
150
151}} // end of namespace svndigest and namespace theplu
152
153#endif
Note: See TracBrowser for help on using the repository browser.