gnuplot-aggregator.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011 Bucknell University
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program 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
 *
 * Author: L. Felipe Perrone (perrone@bucknell.edu)
 *
 * Modified by: Mitch Watrous (watrous@u.washington.edu)
 *
 */
 
#ifndef GNUPLOT_AGGREGATOR_H
#define GNUPLOT_AGGREGATOR_H
 
#include "ns3/data-collection-object.h"
#include "ns3/gnuplot.h"
 
#include <map>
#include <string>
 
namespace ns3
{
 
class GnuplotAggregator : public DataCollectionObject
{
  public:
    enum KeyLocation
    {
        NO_KEY,
        KEY_INSIDE,
        KEY_ABOVE,
        KEY_BELOW
    };
 
    static TypeId GetTypeId();
 
    GnuplotAggregator(const std::string& outputFileNameWithoutExtension);
 
    ~GnuplotAggregator() override;
 
    // Below are hooked to connectors exporting data
    // They are not overloaded since it confuses the compiler when made
    // into callbacks
 
    void Write2d(std::string context, double x, double y);
 
    void Write2dWithXErrorDelta(std::string context, double x, double y, double errorDelta);
 
    void Write2dWithYErrorDelta(std::string context, double x, double y, double errorDelta);
 
    void Write2dWithXYErrorDelta(std::string context,
                                 double x,
                                 double y,
                                 double xErrorDelta,
                                 double yErrorDelta);
 
    // Methods to configure the plot
 
    void SetTerminal(const std::string& terminal);
 
    void SetTitle(const std::string& title);
 
    void SetLegend(const std::string& xLegend, const std::string& yLegend);
 
    void SetExtra(const std::string& extra);
 
    void AppendExtra(const std::string& extra);
 
    // Methods for datasets
 
    void Add2dDataset(const std::string& dataset, const std::string& title);
 
    static void Set2dDatasetDefaultExtra(const std::string& extra);
 
    void Set2dDatasetExtra(const std::string& dataset, const std::string& extra);
 
    void Write2dDatasetEmptyLine(const std::string& dataset);
 
    static void Set2dDatasetDefaultStyle(enum Gnuplot2dDataset::Style style);
 
    void Set2dDatasetStyle(const std::string& dataset, enum Gnuplot2dDataset::Style style);
 
    static void Set2dDatasetDefaultErrorBars(enum Gnuplot2dDataset::ErrorBars errorBars);
 
    void Set2dDatasetErrorBars(const std::string& dataset,
                               enum Gnuplot2dDataset::ErrorBars errorBars);
 
    void SetKeyLocation(enum KeyLocation keyLocation);
 
  private:
    std::string m_outputFileNameWithoutExtension;
 
    std::string m_graphicsFileName;
 
    std::string m_title;
 
    std::string m_terminal;
 
    std::string m_xLegend;
 
    std::string m_yLegend;
 
    std::string m_extra;
 
    bool m_titleSet;
 
    bool m_xAndYLegendsSet;
 
    Gnuplot m_gnuplot;
 
    std::map<std::string, Gnuplot2dDataset> m_2dDatasetMap;
 
}; // class GnuplotAggregator
 
} // namespace ns3
 
#endif // GNUPLOT_AGGREGATOR_H