ns3::GnuplotCollection Class Reference

a simple class to group together multiple gnuplots into one file, e.g. More...

#include "gnuplot.h"

Collaboration diagram for ns3::GnuplotCollection:

Public Member Functions
	GnuplotCollection (const std::string &outputFilename)
void	AddPlot (const Gnuplot &plot)
void	GenerateOutput (std::ostream &os)
void	GenerateOutput (std::ostream &osControl, std::ostream &osData, std::string dataFileName)
Gnuplot &	GetPlot (unsigned int id)
	Return a pointer to one of the added plots. More...
void	SetTerminal (const std::string &terminal)

Private Types
typedef std::vector< Gnuplot >	Plots
	Type of the Gnuplot collection. More...

Private Attributes
std::string	m_outputFilename
	Output file name. More...
Plots	m_plots
	Plots in the collection. More...
std::string	m_terminal
	Gnuplot "terminal" to use. More...

Detailed Description

a simple class to group together multiple gnuplots into one file, e.g.

for PDF multi-page output terminals.

Definition at line 488 of file gnuplot.h.

Member Typedef Documentation

Plots

typedef std::vector<Gnuplot> ns3::GnuplotCollection::Plots

private

Type of the Gnuplot collection.

Definition at line 537 of file gnuplot.h.

Constructor & Destructor Documentation

GnuplotCollection()

ns3::GnuplotCollection::GnuplotCollection

(

const std::string &

outputFilename

)

Parameters

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.

Definition at line 859 of file gnuplot.cc.

Member Function Documentation

AddPlot()

void ns3::GnuplotCollection::AddPlot

(

const Gnuplot &

plot

)

Parameters

plot	add a plot to the collection to be plotted.

Definition at line 872 of file gnuplot.cc.

References m_plots.

GenerateOutput() [1/2]

void ns3::GnuplotCollection::GenerateOutput

(

std::ostream &

os

)

Parameters

os	the output stream on which the relevant gnuplot commands should be generated.

Definition at line 887 of file gnuplot.cc.

References m_outputFilename, m_plots, and m_terminal.

GenerateOutput() [2/2]

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

Parameters

osControl	the output stream on which the relevant gnuplot control commands should be generated. Including output file and terminal headers.
osData	the output stream on which the relevant gnuplot data values should be generated.
dataFileName	the name for the data file that will be written.

Definition at line 905 of file gnuplot.cc.

References m_outputFilename, m_plots, and m_terminal.

GetPlot()

Gnuplot & ns3::GnuplotCollection::GetPlot

(

unsigned int

id

)

Return a pointer to one of the added plots.

Parameters

id	index of plot to return

Returns

reference to plot, throws std::range_error if it does not exist.

Definition at line 878 of file gnuplot.cc.

References m_plots.

SetTerminal()

void ns3::GnuplotCollection::SetTerminal

(

const std::string &

terminal

)

Parameters

terminal

terminal setting string for output. The default terminal string is guessed from the output filename's extension.

Definition at line 866 of file gnuplot.cc.

References m_terminal.

Member Data Documentation

m_outputFilename

std::string ns3::GnuplotCollection::m_outputFilename

private

Output file name.

Definition at line 539 of file gnuplot.h.

Referenced by GenerateOutput().

m_plots

Plots ns3::GnuplotCollection::m_plots

private

Plots in the collection.

Definition at line 542 of file gnuplot.h.

Referenced by AddPlot(), GenerateOutput(), and GetPlot().

m_terminal

std::string ns3::GnuplotCollection::m_terminal

private

Gnuplot "terminal" to use.

Definition at line 540 of file gnuplot.h.

Referenced by GenerateOutput(), and SetTerminal().

---

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

• src/stats/model/gnuplot.h
• src/stats/model/gnuplot.cc