Public Member Functions | Static Public Member Functions

ns3::Gnuplot Class Reference

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

#include <gnuplot.h>

List of all members.

Public Member Functions

 Gnuplot (const std::string &outputFilename="", const std::string &title="")
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)
void AddDataset (const GnuplotDataset &dataset)
void GenerateOutput (std::ostream &os) const

Static Public Member Functions

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

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.


Constructor & Destructor Documentation

ns3::Gnuplot::Gnuplot ( const std::string &  outputFilename = "",
const std::string &  title = "" 
)
Parameters:
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

Member Function Documentation

void ns3::Gnuplot::AddDataset ( const GnuplotDataset dataset )
Parameters:
datasetadd a dataset to the graph to be plotted.
void ns3::Gnuplot::AppendExtra ( const std::string &  extra )
Parameters:
extraappend extra gnuplot directive for output.
static std::string ns3::Gnuplot::DetectTerminal ( const std::string &  filename ) [static]

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

Parameters:
filenameoutput file name
void ns3::Gnuplot::GenerateOutput ( std::ostream &  os ) const
Parameters:
osthe output stream on which the relevant gnuplot commands should be generated. Including output file and terminal headers.
void ns3::Gnuplot::SetExtra ( const std::string &  extra )
Parameters:
extraset extra gnuplot directive for output.
void ns3::Gnuplot::SetLegend ( const std::string &  xLegend,
const std::string &  yLegend 
)
Parameters:
xLegendthe legend for the x horizontal axis
yLegendthe legend for the y vertical axis
void ns3::Gnuplot::SetTerminal ( const std::string &  terminal )
Parameters:
terminalterminal setting string for output. The default terminal string is "png"
void ns3::Gnuplot::SetTitle ( const std::string &  title )
Parameters:
titleset new plot title string to use for this plot.

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