A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
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:

Classes

struct  Data2d
 
struct  Point
 

Public Types

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

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 ()
 
void SetErrorBars (enum ErrorBars errorBars)
 
void SetStyle (enum Style style)
 
- Public Member Functions inherited from ns3::GnuplotDataset
 GnuplotDataset (const GnuplotDataset &original)
 
 ~GnuplotDataset ()
 
GnuplotDatasetoperator= (const GnuplotDataset &original)
 
void SetExtra (const std::string &extra)
 Add extra formatting parameters to this dataset. More...
 
void SetTitle (const std::string &title)
 Change line title. More...
 

Static Public Member Functions

static void SetDefaultErrorBars (enum ErrorBars errorBars)
 
static void SetDefaultStyle (enum Style style)
 
- Static Public Member Functions inherited from ns3::GnuplotDataset
static void SetDefaultExtra (const std::string &extra)
 Change extra formatting style parameters for newly created objects. More...
 

Private Types

typedef std::vector< struct PointPointSet
 

Static Private Attributes

static enum ErrorBars m_defaultErrorBars
 
static enum Style m_defaultStyle
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::GnuplotDataset
 GnuplotDataset (struct Data *data)
 
- Protected Attributes inherited from ns3::GnuplotDataset
struct Datam_data
 
- 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 107 of file gnuplot.h.

Member Enumeration Documentation

Whether errorbars should be used for this dataset.

Definition at line 127 of file gnuplot.h.

The plotting style to use for this dataset.

Definition at line 113 of file gnuplot.h.

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.

Definition at line 263 of file gnuplot.cc.

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.

Definition at line 291 of file gnuplot.cc.

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.

Definition at line 305 of file gnuplot.cc.

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.

Definition at line 320 of file gnuplot.cc.

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

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 334 of file gnuplot.cc.

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.

Definition at line 280 of file gnuplot.cc.

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.

Definition at line 269 of file gnuplot.cc.

void ns3::Gnuplot2dDataset::SetErrorBars ( enum ErrorBars  errorBars)
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.

Definition at line 285 of file gnuplot.cc.

References ns3::GnuplotDataset::m_data.

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

Definition at line 274 of file gnuplot.cc.

References ns3::GnuplotDataset::m_data.


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