A Discrete-Event Network Simulator
API
ns3::Gnuplot Class Reference

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

#include "gnuplot.h"

+ Collaboration diagram for ns3::Gnuplot:

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)
 Writes gnuplot commands and data values to a single output stream. More...
 
void GenerateOutput (std::ostream &osControl, std::ostream &osData, std::string dataFileName)
 Writes gnuplot commands and data values to two different outputs streams. More...
 
void SetDataFileDatasetIndex (unsigned int index)
 Sets the current data stream index in the data file. More...
 
void SetExtra (const std::string &extra)
 
void SetLegend (const std::string &xLegend, const std::string &yLegend)
 
void SetOutputFilename (const std::string &outputFilename)
 
void SetTerminal (const std::string &terminal)
 
void SetTitle (const std::string &title)
 

Static Public Member Functions

static std::string DetectTerminal (const std::string &filename)
 Crude attempt to auto-detect the correct terminal setting by inspecting the filename's extension. More...
 

Private Types

typedef std::vector< GnuplotDatasetDatasets
 Type for Datasets to be used in plots. More...
 

Private Attributes

unsigned int m_dataFileDatasetIndex
 Data set index to plot. More...
 
Datasets m_datasets
 Data sets. More...
 
std::string m_extra
 extra parameters for the plot More...
 
bool m_generateOneOutputFile
 true if only one plot will be generated More...
 
std::string m_outputFilename
 Output file name. More...
 
std::string m_terminal
 Gnuplot "terminal" to use. More...
 
std::string m_title
 Plot title. More...
 
std::string m_xLegend
 X axis legend. More...
 
std::string m_yLegend
 Y axis legend. More...
 

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 367 of file gnuplot.h.

Member Typedef Documentation

typedef std::vector<GnuplotDataset> ns3::Gnuplot::Datasets
private

Type for Datasets to be used in plots.

Definition at line 460 of file gnuplot.h.

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

Definition at line 694 of file gnuplot.cc.

Member Function Documentation

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

Definition at line 756 of file gnuplot.cc.

References m_datasets.

Referenced by ns3::GnuplotAggregator::Add2dDataset(), anonymous_namespace{gnuplot-example.cc}::Create2DPlotFile(), anonymous_namespace{gnuplot-example.cc}::Create2DPlotWithErrorBarsFile(), and anonymous_namespace{gnuplot-example.cc}::Create3DPlotFile().

+ Here is the caller graph for this function:

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 filename
Returns
File extension of the provided filename

Definition at line 708 of file gnuplot.cc.

void ns3::Gnuplot::GenerateOutput ( std::ostream &  os)

Writes gnuplot commands and data values to a single output stream.

Parameters
osthe output stream on which the relevant gnuplot commands should be generated. Including output file and terminal headers.

Definition at line 762 of file gnuplot.cc.

References m_generateOneOutputFile.

Referenced by anonymous_namespace{gnuplot-example.cc}::Create2DPlotFile(), anonymous_namespace{gnuplot-example.cc}::Create2DPlotWithErrorBarsFile(), anonymous_namespace{gnuplot-example.cc}::Create3DPlotFile(), and ns3::GnuplotAggregator::~GnuplotAggregator().

+ Here is the caller graph for this function:

void ns3::Gnuplot::GenerateOutput ( std::ostream &  osControl,
std::ostream &  osData,
std::string  dataFileName 
)

Writes gnuplot commands and data values to two different outputs streams.

Parameters
osControlthe output stream on which the relevant gnuplot contol commands should be generated. Including output file and terminal headers.
osDatathe output stream on which the relevant gnuplot data values should be generated.
dataFileNamethe name for the data file that will be written.

Definition at line 773 of file gnuplot.cc.

References m_dataFileDatasetIndex, m_datasets, m_extra, m_generateOneOutputFile, m_outputFilename, m_terminal, m_title, m_xLegend, m_yLegend, and NS_ASSERT_MSG.

void ns3::Gnuplot::SetDataFileDatasetIndex ( unsigned int  index)

Sets the current data stream index in the data file.

Parameters
indexthe index for the data stream in the data file.

Definition at line 848 of file gnuplot.cc.

References m_dataFileDatasetIndex.

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

Definition at line 743 of file gnuplot.cc.

References m_extra.

Referenced by ns3::GnuplotAggregator::SetExtra().

+ Here is the caller graph for this function:

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

Definition at line 736 of file gnuplot.cc.

References m_xLegend, and m_yLegend.

Referenced by anonymous_namespace{gnuplot-example.cc}::Create2DPlotFile(), anonymous_namespace{gnuplot-example.cc}::Create2DPlotWithErrorBarsFile(), and ns3::GnuplotAggregator::SetLegend().

+ Here is the caller graph for this function:

void ns3::Gnuplot::SetOutputFilename ( const std::string &  outputFilename)
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.

Definition at line 703 of file gnuplot.cc.

References m_outputFilename.

Referenced by ns3::GnuplotAggregator::SetTerminal().

+ Here is the caller graph for this function:

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

Definition at line 724 of file gnuplot.cc.

References m_terminal.

Referenced by anonymous_namespace{gnuplot-example.cc}::Create2DPlotFile(), anonymous_namespace{gnuplot-example.cc}::Create2DPlotWithErrorBarsFile(), anonymous_namespace{gnuplot-example.cc}::Create3DPlotFile(), and ns3::GnuplotAggregator::SetTerminal().

+ Here is the caller graph for this function:

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

Definition at line 730 of file gnuplot.cc.

References m_title.

Referenced by anonymous_namespace{gnuplot-example.cc}::Create2DPlotFile(), anonymous_namespace{gnuplot-example.cc}::Create2DPlotWithErrorBarsFile(), anonymous_namespace{gnuplot-example.cc}::Create3DPlotFile(), and ns3::GnuplotAggregator::SetTitle().

+ Here is the caller graph for this function:

Member Data Documentation

unsigned int ns3::Gnuplot::m_dataFileDatasetIndex
private

Data set index to plot.

Definition at line 474 of file gnuplot.h.

Referenced by GenerateOutput(), and SetDataFileDatasetIndex().

Datasets ns3::Gnuplot::m_datasets
private

Data sets.

Definition at line 465 of file gnuplot.h.

Referenced by AddDataset(), and GenerateOutput().

std::string ns3::Gnuplot::m_extra
private

extra parameters for the plot

Definition at line 470 of file gnuplot.h.

Referenced by AppendExtra(), GenerateOutput(), and SetExtra().

bool ns3::Gnuplot::m_generateOneOutputFile
private

true if only one plot will be generated

Definition at line 472 of file gnuplot.h.

Referenced by GenerateOutput().

std::string ns3::Gnuplot::m_outputFilename
private

Output file name.

Definition at line 462 of file gnuplot.h.

Referenced by GenerateOutput(), and SetOutputFilename().

std::string ns3::Gnuplot::m_terminal
private

Gnuplot "terminal" to use.

Definition at line 463 of file gnuplot.h.

Referenced by GenerateOutput(), and SetTerminal().

std::string ns3::Gnuplot::m_title
private

Plot title.

Definition at line 467 of file gnuplot.h.

Referenced by GenerateOutput(), and SetTitle().

std::string ns3::Gnuplot::m_xLegend
private

X axis legend.

Definition at line 468 of file gnuplot.h.

Referenced by GenerateOutput(), and SetLegend().

std::string ns3::Gnuplot::m_yLegend
private

Y axis legend.

Definition at line 469 of file gnuplot.h.

Referenced by GenerateOutput(), and SetLegend().


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