gnuplot.h

Go to the documentation of this file.

/*
 * Copyright (c) 2007 INRIA, 2008 Timo Bingmann
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Original Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 * Enhancements: Timo Bingmann <timo.bingmann@student.kit.edu>
 */
#ifndef GNUPLOT_H
#define GNUPLOT_H
 
#include <string>
#include <utility>
#include <vector>
 
namespace ns3
{
 
/**
 * \ingroup gnuplot
 *
 * \brief Abstract class to store a plot line to be used by ns3::Gnuplot.
 *
 * This class contains a reference counted data object in m_data. The data
 * object contains different structs derived from struct Data by subclasses.
 */
class GnuplotDataset
{
  public:
    /**
     * Reference-counting copy constructor.
     * \param original Original GnuPlotDataset
     */
    GnuplotDataset(const GnuplotDataset& original);
 
    /**
     * Reference-counting destructor.
     */
    ~GnuplotDataset();
 
    /**
     * Reference-counting assignment operator.
     * \param original Right-hand side of assignment operator
     * \return Copy of original GnuplotDataset
     */
    GnuplotDataset& operator=(const GnuplotDataset& original);
 
    /**
     * \brief Change line title.
     * \param title the new title string to use for this dataset.
     *
     * \note If you want your title to contain a newline character,
     *       escape it like this:  "First line\\nSecond line" so that
     *       it is converted to "First line\nSecond line" in the plot file.
     */
    void SetTitle(const std::string& title);
 
    /**
     * \brief Change extra formatting style parameters for newly created objects.
     * \param extra       extra formatting
     */
    static void SetDefaultExtra(const std::string& extra);
 
    /**
     * \brief Add extra formatting parameters to this dataset.
     * \param extra       extra formatting
     */
    void SetExtra(const std::string& extra);
 
  protected:
    /// Friend because it accesses m_data and it's virtual functions directly in
    /// GenerateOutput().
    friend class Gnuplot;
 
    /**
     * \brief Extra gnuplot parameters set on every newly created dataset.
     */
    static std::string m_defaultExtra;
 
    /**
     * \brief Derived classes subclass this struct and add their own data fields.
     */
    struct Data;
 
    /**
     * Called by constructors of derived classes.
     * \param data the reference counted data object representing this dataset.
     */
    GnuplotDataset(Data* data);
 
    /**
     * Reference counted data object.
     */
    Data* m_data;
};
 
/**
 * \ingroup gnuplot
 *
 * \class Gnuplot2dDataset
 * \brief Class to represent a 2D points plot. Set the line or points style
 * using SetStyle() and set points using Add().
 */
class Gnuplot2dDataset : public GnuplotDataset
{
  public:
    /**
     * The plotting style to use for this dataset.
     */
    enum Style
    {
        LINES,
        POINTS,
        LINES_POINTS,
        DOTS,
        IMPULSES,
        STEPS,
        FSTEPS,
        HISTEPS,
    };
 
    /**
     * Whether errorbars should be used for this dataset.
     */
    enum ErrorBars
    {
        NONE,
        X,
        Y,
        XY
    };
 
    /**
     * \param title the title to be associated to this dataset (default "Untitled").
     *
     * Create an empty dataset. Usually, the dataset's title is
     * displayed in the legend box.
     */
    Gnuplot2dDataset(const std::string& title = "Untitled");
 
    /**
     * Change default style for all newly created objects.
     * \param style the style of plotting to use for newly created datasets.
     */
    static void SetDefaultStyle(Style style);
 
    /**
     * \param style the style of plotting to use for this dataset.
     */
    void SetStyle(Style style);
 
    /**
     * Change default errorbars style for all newly created objects.
     * \param errorBars the style of errorbars to use for newly created datasets.
     */
    static void SetDefaultErrorBars(ErrorBars errorBars);
 
    /**
     * \param errorBars the style of errorbars to display.
     *
     * If you use any style other than none, you need
     * to make sure you store the delta information in
     * this dataset with the right GnuplotDataset::Add
     * method.
     */
    void SetErrorBars(ErrorBars errorBars);
 
    /**
     * \param x x coord to new data point
     * \param y y coord to new data point
     *
     * Use this method with error bar style NONE.
     */
    void Add(double x, double y);
 
    /**
     * \param x x coord to new data point
     * \param y y coord to new data point
     * \param errorDelta x and y data point uncertainty
     *
     * Use this method with error bar style X or Y.
     */
    void Add(double x, double y, double errorDelta);
 
    /**
     * \param x x coord to new data point
     * \param y y coord to new data point
     * \param xErrorDelta x data point uncertainty
     * \param yErrorDelta y data point uncertainty
     *
     * Use this method with error bar style XY.
     */
    void Add(double x, double y, double xErrorDelta, double yErrorDelta);
 
    /**
     * Add an empty line in the data output sequence. Empty lines in the plot
     * data break continuous lines and do other things in the output.
     */
    void AddEmptyLine();
 
  private:
    /**
     * A point in a 2D plot
     */
    struct Point
    {
        bool empty; //!< the point is empty
        double x;   //!< X coordinate
        double y;   //!< Y coordinate
        double dx;  //!< X error delta
        double dy;  //!< Y error delta
    };
 
    /// The set of points in the dataset
    typedef std::vector<Point> PointSet;
 
    static Style m_defaultStyle;         //!< default plot style
    static ErrorBars m_defaultErrorBars; //!< default error bars type
 
    /// Forward declaration of the internal data class.
    struct Data2d;
};
 
/**
 * \ingroup gnuplot
 *
 * \brief Class to represent a 2D function expression plot.
 *
 * Since the function expression is not escaped, styles and extras could just
 * as well be included in the expression string.
 */
class Gnuplot2dFunction : public GnuplotDataset
{
  public:
    /**
     * \param title the title to be associated to this dataset.
     * \param function function to plot
     *
     * Create an function dataset. Usually, the dataset's title is displayed in
     * the legend box.
     */
    Gnuplot2dFunction(const std::string& title = "Untitled", const std::string& function = "");
 
    /**
     * \param function new function string to set
     */
    void SetFunction(const std::string& function);
 
  private:
    /// Forward declaration of the internal data class.
    struct Function2d;
};
 
/**
 * \ingroup gnuplot
 *
 * \brief Class to represent a 3D points plot. Set the line or points style
 * using SetStyle() and set points using Add().
 */
class Gnuplot3dDataset : public GnuplotDataset
{
  public:
    /**
     * \param title the title to be associated to this dataset.
     *
     * Create an empty dataset. Usually, the dataset's title is
     * displayed in the legend box.
     */
    Gnuplot3dDataset(const std::string& title = "Untitled");
 
    /**
     * Change default style for all newly created objects.
     * \param style the style of plotting to use for newly created datasets.
     */
    static void SetDefaultStyle(const std::string& style);
 
    /**
     * \param style the style of plotting to use for this dataset.
     */
    void SetStyle(const std::string& style);
 
    /**
     * \param x x coord to new data point
     * \param y y coord to new data point
     * \param z z coord to new data point
     *
     * Use this method to add a new 3D point
     */
    void Add(double x, double y, double z);
 
    /**
     * Add an empty line in the data output sequence. Empty lines in the plot
     * data break continuous lines and do other things in the output.
     */
    void AddEmptyLine();
 
  private:
    /**
     * A point in a 3D plot
     */
    struct Point
    {
        bool empty; //!< the point is empty
        double x;   //!< X coordinate
        double y;   //!< Y coordinate
        double z;   //!< Z coordinate
    };
 
    /// The set of points in the dataset
    typedef std::vector<Point> PointSet;
 
    static std::string m_defaultStyle; //!< default plot style
 
    /// Forward declaration of the internal data class.
    struct Data3d;
};
 
/**
 * \ingroup gnuplot
 *
 * \brief Class to represent a 3D function expression plot.
 *
 * Since the function expression is not escaped, styles and extras could just as
 * well be included in the expression string. The only difference to
 * Gnuplot2dFunction is the splot command string.
 */
class Gnuplot3dFunction : public GnuplotDataset
{
  public:
    /**
     * \param title the title to be associated to this dataset.
     * \param function function to plot
     *
     * Create an function dataset. Usually, the dataset's title is displayed in
     * the legend box.
     */
    Gnuplot3dFunction(const std::string& title = "Untitled", const std::string& function = "");
 
    /**
     * \param function new function string to set
     */
    void SetFunction(const std::string& function);
 
  private:
    /// Forward declaration of the internal data class.
    struct Function3d;
};
 
/**
 * \ingroup gnuplot
 *
 * \brief a simple class to generate gnuplot-ready plotting commands
 *        from a set of datasets.
 *
 * This class really represents a single graph on which multiple datasets
 * can be plotted.
 */
class Gnuplot
{
  public:
    /**
     * \param outputFilename the name of the file where the rendering of the
     *        graph will be generated if you feed the command stream output by
     *        Gnuplot::GenerateOutput to the gnuplot program.
     * \param title title line of the plot page
     */
    Gnuplot(const std::string& outputFilename = "", const std::string& title = "");
 
    /**
     * \param outputFilename the name of the file where the rendering of the
     *        graph will be generated if you feed the command stream output by
     *        Gnuplot::GenerateOutput to the gnuplot program.
     */
    void SetOutputFilename(const std::string& outputFilename);
 
    /**
     * Crude attempt to auto-detect the correct terminal setting by inspecting
     * the filename's extension.
     * \param filename output filename
     * \return File extension of the provided filename
     */
    static std::string DetectTerminal(const std::string& filename);
 
    /**
     * \param terminal terminal setting string for output. The default terminal
     * string is "png"
     */
    void SetTerminal(const std::string& terminal);
 
    /**
     * \param title set new plot title string to use for this plot.
     */
    void SetTitle(const std::string& title);
 
    /**
     * \param xLegend the legend for the x horizontal axis
     * \param yLegend the legend for the y vertical axis
     */
    void SetLegend(const std::string& xLegend, const std::string& yLegend);
 
    /**
     * \param extra set extra gnuplot directive for output.
     */
    void SetExtra(const std::string& extra);
 
    /**
     * \param extra append extra gnuplot directive for output.
     */
    void AppendExtra(const std::string& extra);
 
    /**
     * \param dataset add a dataset to the graph to be plotted.
     */
    void AddDataset(const GnuplotDataset& dataset);
 
    /**
     * \param os the output stream on which the relevant gnuplot
     * commands should be generated. Including output file and terminal
     * headers.
     *
     * \brief Writes gnuplot commands and data values to a single
     * output stream.
     */
    void GenerateOutput(std::ostream& os);
 
    /**
     * \param osControl the output stream on which the relevant gnuplot
     * control commands should be generated. Including output file and
     * terminal headers.
     * \param osData the output stream on which the relevant gnuplot
     * data values should be generated.
     * \param dataFileName the name for the data file that will be
     * written.
     *
     * \brief Writes gnuplot commands and data values to two
     * different outputs streams.
     */
    void GenerateOutput(std::ostream& osControl, std::ostream& osData, std::string dataFileName);
 
    /**
     * \param index the index for the data stream in the data file.
     *
     * \brief Sets the current data stream index in the data file.
     */
    void SetDataFileDatasetIndex(unsigned int index);
 
  private:
    /// Type for Datasets to be used in plots
    typedef std::vector<GnuplotDataset> Datasets;
 
    std::string m_outputFilename; //!< Output file name
    std::string m_terminal;       //!< Gnuplot "terminal" to use
 
    Datasets m_datasets; //!< Data sets
 
    std::string m_title;   //!< Plot title
    std::string m_xLegend; //!< X axis legend
    std::string m_yLegend; //!< Y axis legend
    std::string m_extra;   //!< extra parameters for the plot
 
    bool m_generateOneOutputFile; //!< true if only one plot will be generated
 
    unsigned int m_dataFileDatasetIndex; //!< Data set index to plot
};
 
/**
 * \ingroup gnuplot
 *
 * \brief a simple class to group together multiple gnuplots into one file,
 * e.g. for PDF multi-page output terminals.
 */
class GnuplotCollection
{
  public:
    /**
     * \param outputFilename the name of the file where the rendering of the
     *        graph will be generated if you feed the command stream output by
     *        GnuplotCollection::GenerateOutput to the gnuplot program.
     */
    GnuplotCollection(const std::string& outputFilename);
 
    /**
     * \param terminal terminal setting string for output. The default terminal
     * string is guessed from the output filename's extension.
     */
    void SetTerminal(const std::string& terminal);
 
    /**
     * \param plot add a plot to the collection to be plotted.
     */
    void AddPlot(const Gnuplot& plot);
 
    /**
     * Return a pointer to one of the added plots.
     * \param id  index of plot to return
     * \return    reference to plot, throws std::range_error if it does not exist.
     */
    Gnuplot& GetPlot(unsigned int id);
 
    /**
     * \param os the output stream on which the relevant gnuplot commands should
     * be generated.
     */
    void GenerateOutput(std::ostream& os);
 
    /**
     * \param osControl the output stream on which the relevant gnuplot
     * control commands should be generated. Including output file and
     * terminal headers.
     * \param osData the output stream on which the relevant gnuplot
     * data values should be generated.
     * \param dataFileName the name for the data file that will be
     * written.
     */
    void GenerateOutput(std::ostream& osControl, std::ostream& osData, std::string dataFileName);
 
  private:
    /// Type of the Gnuplot collection
    typedef std::vector<Gnuplot> Plots;
 
    std::string m_outputFilename; //!< Output file name
    std::string m_terminal;       //!< Gnuplot "terminal" to use
 
    Plots m_plots; //!< Plots in the collection
};
 
} // namespace ns3
 
#endif /* GNUPLOT_H */