A Discrete-Event Network Simulator
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::Gnuplot Class Reference

a simple class to generate gnuplot-ready plotting commands from a set of datasets. More...

#include <gnuplot.h>

Public Member Functions

 Gnuplot (const std::string &outputFilename="", const std::string &title="")
void AddDataset (const GnuplotDataset &dataset)
void AppendExtra (const std::string &extra)
void GenerateOutput (std::ostream &os) const
void SetExtra (const std::string &extra)
void SetLegend (const std::string &xLegend, const std::string &yLegend)
void SetTerminal (const std::string &terminal)
void SetTitle (const std::string &title)

Static Public Member Functions

static std::string DetectTerminal (const std::string &filename)

Private Types

typedef std::vector
< GnuplotDataset

Private Attributes

Datasets m_datasets
std::string m_extra
std::string m_outputFilename
std::string m_terminal
std::string m_title
std::string m_xLegend
std::string m_yLegend

Detailed Description

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.

Definition at line 343 of file gnuplot.h.

Constructor & Destructor Documentation

ns3::Gnuplot::Gnuplot ( const std::string &  outputFilename = "",
const std::string &  title = "" 
outputFilenamethe 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.
titletitle line of the plot page

Definition at line 565 of file gnuplot.cc.

Member Function Documentation

void ns3::Gnuplot::AddDataset ( const GnuplotDataset dataset)
datasetadd a dataset to the graph to be plotted.

Definition at line 620 of file gnuplot.cc.

void ns3::Gnuplot::AppendExtra ( const std::string &  extra)
extraappend extra gnuplot directive for output.

Definition at line 613 of file gnuplot.cc.

std::string ns3::Gnuplot::DetectTerminal ( const std::string &  filename)

Crude attempt to auto-detect the correct terminal setting by inspecting the filename's extension.

filenameoutput file name

Definition at line 572 of file gnuplot.cc.

void ns3::Gnuplot::GenerateOutput ( std::ostream &  os) const
osthe output stream on which the relevant gnuplot commands should be generated. Including output file and terminal headers.

Definition at line 626 of file gnuplot.cc.

References NS_ASSERT_MSG.

void ns3::Gnuplot::SetExtra ( const std::string &  extra)
extraset extra gnuplot directive for output.

Definition at line 607 of file gnuplot.cc.

void ns3::Gnuplot::SetLegend ( const std::string &  xLegend,
const std::string &  yLegend 
xLegendthe legend for the x horizontal axis
yLegendthe legend for the y vertical axis

Definition at line 600 of file gnuplot.cc.

void ns3::Gnuplot::SetTerminal ( const std::string &  terminal)
terminalterminal setting string for output. The default terminal string is "png"

Definition at line 588 of file gnuplot.cc.

void ns3::Gnuplot::SetTitle ( const std::string &  title)
titleset new plot title string to use for this plot.

Definition at line 594 of file gnuplot.cc.

The documentation for this class was generated from the following files: