ns-3
ns3::Gnuplot2dDataset Class Reference

Class to represent a 2D points plot. Set the line or points style using SetStyle() and set points using Add(). More...

#include <gnuplot.h>

Inheritance diagram for ns3::Gnuplot2dDataset:
Collaboration diagram for ns3::Gnuplot2dDataset:

List of all members.

Classes

struct  Point

Public Types

enum  Style {
  LINES, POINTS, LINES_POINTS, DOTS,
  IMPULSES, STEPS, FSTEPS, HISTEPS
}
enum  ErrorBars { NONE, X, Y, XY }

Public Member Functions

 Gnuplot2dDataset (const std::string &title="Untitled")
void SetStyle (enum Style style)
void SetErrorBars (enum ErrorBars errorBars)
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 ()

Static Public Member Functions

static void SetDefaultStyle (enum Style style)
static void SetDefaultErrorBars (enum ErrorBars errorBars)

Detailed Description

Class to represent a 2D points plot. Set the line or points style using SetStyle() and set points using Add().


Member Enumeration Documentation

Whether errorbars should be used for this dataset.

The plotting style to use for this dataset.


Constructor & Destructor Documentation

ns3::Gnuplot2dDataset::Gnuplot2dDataset ( const std::string &  title = "Untitled")
Parameters:
titlethe title to be associated to this dataset.

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


Member Function Documentation

void ns3::Gnuplot2dDataset::Add ( double  x,
double  y 
)
Parameters:
xx coord to new data point
yy coord to new data point

Use this method with error bar style NONE.

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

void ns3::Gnuplot2dDataset::Add ( double  x,
double  y,
double  errorDelta 
)
Parameters:
xx coord to new data point
yy coord to new data point
errorDeltax and y data point uncertainty

Use this method with error bar style X or Y.

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

void ns3::Gnuplot2dDataset::Add ( double  x,
double  y,
double  xErrorDelta,
double  yErrorDelta 
)
Parameters:
xx coord to new data point
yy coord to new data point
xErrorDeltax data point uncertainty
yErrorDeltay data point uncertainty

Use this method with error bar style XY.

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

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.

References ns3::GnuplotDataset::m_data.

void ns3::Gnuplot2dDataset::SetDefaultErrorBars ( enum ErrorBars  errorBars) [static]

Change default errorbars style for all newly created objects.

Parameters:
errorBarsthe style of errorbars to use for newly created datasets.
void ns3::Gnuplot2dDataset::SetDefaultStyle ( enum Style  style) [static]

Change default style for all newly created objects.

Parameters:
stylethe style of plotting to use for newly created datasets.
Parameters:
errorBarsthe 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.

References ns3::GnuplotDataset::m_data.

void ns3::Gnuplot2dDataset::SetStyle ( enum Style  style)
Parameters:
stylethe style of plotting to use for this dataset.

References ns3::GnuplotDataset::m_data.


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