ns3::Gnuplot2dFunction::Function2d Struct Reference

Structure storing the function to be used for a 2D plot. More...

Inheritance diagram for ns3::Gnuplot2dFunction::Function2d:

Collaboration diagram for ns3::Gnuplot2dFunction::Function2d:

Public Member Functions
	Function2d (const std::string &title, const std::string &function)
	Initializes with the function and title. 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
std::string	m_function
	Function to use. 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 function to be used for a 2D plot.

Definition at line 420 of file gnuplot.cc.

Constructor & Destructor Documentation

Function2d()

ns3::Gnuplot2dFunction::Function2d::Function2d	(	const std::string &	title,
		const std::string &	function
	)

Initializes with the function and title.

Parameters

title	Title of the plot
function	Function to plot

Definition at line 443 of file gnuplot.cc.

Member Function Documentation

GetCommand()

std::string ns3::Gnuplot2dFunction::Function2d::GetCommand ( ) const

virtual

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

Returns

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

Implements ns3::GnuplotDataset::Data.

Definition at line 450 of file gnuplot.cc.

IsEmpty()

bool ns3::Gnuplot2dFunction::Function2d::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 476 of file gnuplot.cc.

PrintDataFile()

void ns3::Gnuplot2dFunction::Function2d::PrintDataFile ( std::ostream &  os, bool  generateOneOutputFile  ) const

virtual

Print the inline data file contents trailing the plot command.

Empty for functions.

Parameters

os	Output stream
generateOneOutputFile	If true, generate only one output file.

Implements ns3::GnuplotDataset::Data.

Definition at line 471 of file gnuplot.cc.

PrintExpression()

void ns3::Gnuplot2dFunction::Function2d::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

os	Output stream
generateOneOutputFile	If true, generate only one output file.
dataFileDatasetIndex	Dataset Index
dataFileName	Dataset file name

Implements ns3::GnuplotDataset::Data.

Definition at line 456 of file gnuplot.cc.

Member Data Documentation

m_function

std::string ns3::Gnuplot2dFunction::Function2d::m_function

Function to use.

Definition at line 424 of file gnuplot.cc.

---

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

• src/stats/model/gnuplot.cc