Class to represent a 2D points plot. More...

#include "gnuplot.h"

Inheritance diagram for ns3::Gnuplot2dDataset:

Collaboration diagram for ns3::Gnuplot2dDataset:

Classes
struct	Data2d
	Structure storing the data to for a 2D plot. More...

struct	Point
	A point in a 2D plot. More...

Public Types
enum	ErrorBars { NONE , X , Y , XY }
	Whether errorbars should be used for this dataset. More...

enum	Style { LINES , POINTS , LINES_POINTS , DOTS , IMPULSES , STEPS , FSTEPS , HISTEPS }
	The plotting style to use for this dataset. More...

Public Member Functions
	Gnuplot2dDataset (const std::string &title="Untitled")

void	Add (double x, double y)

void	Add (double x, double y, double errorDelta)

void	Add (double x, double y, double xErrorDelta, double yErrorDelta)

void	AddEmptyLine ()
	Add an empty line in the data output sequence.

void	SetErrorBars (ErrorBars errorBars)

void	SetStyle (Style style)

Public Member Functions inherited from ns3::GnuplotDataset
	GnuplotDataset (const GnuplotDataset &original)
	Reference-counting copy constructor.

	~GnuplotDataset ()
	Reference-counting destructor.

GnuplotDataset &	operator= (const GnuplotDataset &original)
	Reference-counting assignment operator.

void	SetExtra (const std::string &extra)
	Add extra formatting parameters to this dataset.

void	SetTitle (const std::string &title)
	Change line title.

Static Public Member Functions
static void	SetDefaultErrorBars (ErrorBars errorBars)
	Change default errorbars style for all newly created objects.

static void	SetDefaultStyle (Style style)
	Change default style for all newly created objects.

Static Public Member Functions inherited from ns3::GnuplotDataset
static void	SetDefaultExtra (const std::string &extra)
	Change extra formatting style parameters for newly created objects.

Private Types
typedef std::vector< Point >	PointSet
	The set of points in the dataset.

Static Private Attributes
static ErrorBars	m_defaultErrorBars = NONE
	default error bars type

static Style	m_defaultStyle = LINES
	default plot style

Additional Inherited Members
Protected Member Functions inherited from ns3::GnuplotDataset
	GnuplotDataset (Data *data)
	Called by constructors of derived classes.

Protected Attributes inherited from ns3::GnuplotDataset
Data *	m_data
	Reference counted data object.

Static Protected Attributes inherited from ns3::GnuplotDataset
static std::string	m_defaultExtra = ""
	Extra gnuplot parameters set on every newly created dataset.

Detailed Description

Class to represent a 2D points plot.

Set the line or points style using SetStyle() and set points using Add().

Definition at line 104 of file gnuplot.h.

Member Typedef Documentation

◆ PointSet

typedef std::vector<Point> ns3::Gnuplot2dDataset::PointSet

private

The set of points in the dataset.

Definition at line 215 of file gnuplot.h.

Member Enumeration Documentation

◆ ErrorBars

enum ns3::Gnuplot2dDataset::ErrorBars

Whether errorbars should be used for this dataset.

Enumerator
NONE
X
Y
XY

Definition at line 125 of file gnuplot.h.

◆ Style

enum ns3::Gnuplot2dDataset::Style

The plotting style to use for this dataset.

Enumerator
LINES
POINTS
LINES_POINTS
DOTS
IMPULSES
STEPS
FSTEPS
HISTEPS

Definition at line 110 of file gnuplot.h.

Constructor & Destructor Documentation

◆ Gnuplot2dDataset()

ns3::Gnuplot2dDataset::Gnuplot2dDataset ( const std::string & title = "Untitled" )

Parameters

title the title to be associated to this dataset (default "Untitled").

Create an empty dataset. Usually, the dataset's title is displayed in the legend box.

Definition at line 336 of file gnuplot.cc.

Member Function Documentation

◆ Add() [1/3]

void ns3::Gnuplot2dDataset::Add	(	double	x,
		double	y )

Parameters

x	x coord to new data point
y	y coord to new data point

Use this method with error bar style NONE.

Definition at line 366 of file gnuplot.cc.

References data, ns3::GnuplotDataset::m_data, NONE, and NS_ASSERT.

Referenced by Experiment::AdvancePosition(), NodeStatistics::AdvancePosition(), ChangeSignalAndReportRate(), Experiment::CheckThroughput(), anonymous_namespace{gnuplot-example.cc}::Create2DPlotFile(), anonymous_namespace{gnuplot-example.cc}::Create2DPlotWithErrorBarsFile(), CubicCwndTracer(), GraphBattery1(), GraphBattery2(), GraphBattery3(), GraphBattery4(), GraphBattery5(), Experiment::IncrementCw(), TestDeterministic(), and TestDeterministicByTime().

Here is the caller graph for this function:

◆ Add() [2/3]

void ns3::Gnuplot2dDataset::Add	(	double	x,
		double	y,
		double	errorDelta )

Parameters

x	x coord to new data point
y	y coord to new data point
errorDelta	x and y data point uncertainty

Use this method with error bar style X or Y.

Definition at line 380 of file gnuplot.cc.

References data, ns3::GnuplotDataset::m_data, NS_ASSERT, X, and Y.

◆ Add() [3/3]

void ns3::Gnuplot2dDataset::Add	(	double	x,
		double	y,
		double	xErrorDelta,
		double	yErrorDelta )

Parameters

x	x coord to new data point
y	y coord to new data point
xErrorDelta	x data point uncertainty
yErrorDelta	y data point uncertainty

Use this method with error bar style XY.

Definition at line 395 of file gnuplot.cc.

References data, ns3::GnuplotDataset::m_data, NS_ASSERT, and XY.

◆ AddEmptyLine()

void ns3::Gnuplot2dDataset::AddEmptyLine ( )

Add an empty line in the data output sequence.

Empty lines in the plot data break continuous lines and do other things in the output.

Definition at line 409 of file gnuplot.cc.

References data, and ns3::GnuplotDataset::m_data.

◆ SetDefaultErrorBars()

void ns3::Gnuplot2dDataset::SetDefaultErrorBars ( ErrorBars errorBars )

static

Change default errorbars style for all newly created objects.

Parameters

errorBars the style of errorbars to use for newly created datasets.

Definition at line 354 of file gnuplot.cc.

References m_defaultErrorBars.

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

Here is the caller graph for this function:

◆ SetDefaultStyle()

void ns3::Gnuplot2dDataset::SetDefaultStyle ( Style style )

static

Change default style for all newly created objects.

Parameters

style the style of plotting to use for newly created datasets.

Definition at line 342 of file gnuplot.cc.

References m_defaultStyle.

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

Here is the caller graph for this function:

◆ SetErrorBars()

void ns3::Gnuplot2dDataset::SetErrorBars ( ErrorBars errorBars )

Parameters

errorBars the style of errorbars to display.

If you use any style other than none, you need to make sure you store the delta information in this dataset with the right GnuplotDataset::Add method.

Definition at line 360 of file gnuplot.cc.

References ns3::GnuplotDataset::m_data.

Referenced by anonymous_namespace{gnuplot-example.cc}::Create2DPlotWithErrorBarsFile().

Here is the caller graph for this function:

◆ SetStyle()

void ns3::Gnuplot2dDataset::SetStyle ( Style style )

Parameters

style the style of plotting to use for this dataset.

Definition at line 348 of file gnuplot.cc.

References ns3::GnuplotDataset::m_data.

Referenced by Experiment::Experiment(), anonymous_namespace{gnuplot-example.cc}::Create2DPlotFile(), anonymous_namespace{gnuplot-example.cc}::Create2DPlotWithErrorBarsFile(), TestDeterministic(), and TestDeterministicByTime().

Here is the caller graph for this function:

Member Data Documentation

◆ m_defaultErrorBars

Gnuplot2dDataset::ErrorBars ns3::Gnuplot2dDataset::m_defaultErrorBars = NONE

staticprivate

default error bars type

Default error bars type static instance.

Definition at line 218 of file gnuplot.h.

Referenced by SetDefaultErrorBars().

◆ m_defaultStyle

Gnuplot2dDataset::Style ns3::Gnuplot2dDataset::m_defaultStyle = LINES

staticprivate

default plot style

Default plot style static instance.

Definition at line 217 of file gnuplot.h.

Referenced by SetDefaultStyle().

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

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PointSet

Member Enumeration Documentation

◆ ErrorBars

◆ Style

Constructor & Destructor Documentation

◆ Gnuplot2dDataset()

Member Function Documentation

◆ Add() [1/3]

◆ Add() [2/3]

◆ Add() [3/3]

◆ AddEmptyLine()

◆ SetDefaultErrorBars()

◆ SetDefaultStyle()

◆ SetErrorBars()

◆ SetStyle()

Member Data Documentation

◆ m_defaultErrorBars

◆ m_defaultStyle