A Discrete-Event Network Simulator
API
Public Member Functions | Public Attributes | List of all members
ns3::Gnuplot3dDataset::Data3d Struct Reference

Structure storing the data for a 3D plot. More...

+ Inheritance diagram for ns3::Gnuplot3dDataset::Data3d:

Public Member Functions

 Data3d (const std::string &title)
 Initializes with value from m_defaultStyle. More...
 
virtual std::string GetCommand () const
 Returns the plot type ("plot" or "splot"). More...
 
virtual bool IsEmpty () const
 Checks to see if this GnuplotDataset is empty. More...
 
virtual void PrintDataFile (std::ostream &os, bool generateOneOutputFile) const
 Print the inline data file contents trailing the plot command. More...
 
virtual void PrintExpression (std::ostream &os, bool generateOneOutputFile, unsigned int dataFileDatasetIndex, std::string &dataFileName) const
 Prints the plot description used as argument to (s)plot. More...
 
- Public Member Functions inherited from ns3::GnuplotDataset::Data
 Data (const std::string &title)
 Initializes the reference counter to 1 and sets m_title and m_extra. More...
 
virtual ~Data ()
 Required. More...
 

Public Attributes

PointSet m_pointset
 The set of points in this data set. More...
 
std::string m_style
 The plotting style to use for this dataset. More...
 
- Public Attributes inherited from ns3::GnuplotDataset::Data
std::string m_extra
 Extra parameters for the plot. More...
 
unsigned int m_references
 ref/unref counter for garbage collection More...
 
std::string m_title
 Dataset title. More...
 

Detailed Description

Structure storing the data for a 3D plot.

Definition at line 497 of file gnuplot.cc.

Constructor & Destructor Documentation

◆ Data3d()

ns3::Gnuplot3dDataset::Data3d::Data3d ( const std::string &  title)

Initializes with value from m_defaultStyle.

Parameters
titleDataset title

Definition at line 520 of file gnuplot.cc.

Member Function Documentation

◆ GetCommand()

std::string ns3::Gnuplot3dDataset::Data3d::GetCommand ( ) const
virtual

Returns the plot type ("plot" or "splot").

Returns
the plot type ("plot" or "splot").

Implements ns3::GnuplotDataset::Data.

Definition at line 527 of file gnuplot.cc.

◆ IsEmpty()

bool ns3::Gnuplot3dDataset::Data3d::IsEmpty ( ) const
virtual

Checks to see if this GnuplotDataset is empty.

Returns
indicates if this GnuplotDataset is empty.

Implements ns3::GnuplotDataset::Data.

Definition at line 567 of file gnuplot.cc.

◆ PrintDataFile()

void ns3::Gnuplot3dDataset::Data3d::PrintDataFile ( std::ostream &  os,
bool  generateOneOutputFile 
) const
virtual

Print the inline data file contents trailing the plot command.

Empty for functions.

Parameters
osOutput stream
generateOneOutputFileIf true, generate only one output file.

Implements ns3::GnuplotDataset::Data.

Definition at line 551 of file gnuplot.cc.

◆ PrintExpression()

void ns3::Gnuplot3dDataset::Data3d::PrintExpression ( std::ostream &  os,
bool  generateOneOutputFile,
unsigned int  dataFileDatasetIndex,
std::string &  dataFileName 
) const
virtual

Prints the plot description used as argument to (s)plot.

Either the function expression or a datafile description. Should include m_title and m_extra in the output.

If more than one output file is being generated, i.e. separate data and control files, then the index for the current dataset and the name for the data file are also included.

Parameters
osOutput stream
generateOneOutputFileIf true, generate only one output file.
dataFileDatasetIndexDataset Index
dataFileNameDataset file name

Implements ns3::GnuplotDataset::Data.

Definition at line 533 of file gnuplot.cc.

Member Data Documentation

◆ m_pointset

PointSet ns3::Gnuplot3dDataset::Data3d::m_pointset

The set of points in this data set.

Definition at line 503 of file gnuplot.cc.

◆ m_style

std::string ns3::Gnuplot3dDataset::Data3d::m_style

The plotting style to use for this dataset.

Definition at line 501 of file gnuplot.cc.


The documentation for this struct was generated from the following file: