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

Inheritance diagram for ns3::Gnuplot3dFunction::Function3d:

Collaboration diagram for ns3::Gnuplot3dFunction::Function3d:

Public Member Functions
	Function3d (const std::string &title, const std::string &function)
	Initializes with the function and title.

	Function3d (const std::string &title, const std::string &function)
	Initializes with the function and title.

std::string	GetCommand () const override
	Returns the plot type ("plot" or "splot").

std::string	GetCommand () const override
	Returns the plot type ("plot" or "splot").

bool	IsEmpty () const override
	Checks to see if this GnuplotDataset is empty.

bool	IsEmpty () const override
	Checks to see if this GnuplotDataset is empty.

void	PrintDataFile (std::ostream &os, bool generateOneOutputFile) const override
	Print the inline data file contents trailing the plot command.

void	PrintDataFile (std::ostream &os, bool generateOneOutputFile) const override
	Print the inline data file contents trailing the plot command.

void	PrintExpression (std::ostream &os, bool generateOneOutputFile, unsigned int dataFileDatasetIndex, std::string &dataFileName) const override
	Prints the plot description used as argument to (s)plot.

void	PrintExpression (std::ostream &os, bool generateOneOutputFile, unsigned int dataFileDatasetIndex, std::string &dataFileName) const override
	Prints the plot description used as argument to (s)plot.

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.

	Data (const std::string &title)
	Initializes the reference counter to 1 and sets m_title and m_extra.

virtual	~Data ()
	Required.

virtual	~Data ()
	Required.

Public Attributes
std::string	m_function
	Function to use.

Public Attributes inherited from ns3::GnuplotDataset::Data
std::string	m_extra
	Extra parameters for the plot.

unsigned int	m_references
	ref/unref counter for garbage collection

std::string	m_title
	Dataset title.

Detailed Description

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

Definition at line 639 of file gnuplot.cc.

Constructor & Destructor Documentation

◆ Function3d() [1/2]

ns3::Gnuplot3dFunction::Function3d::Function3d	(	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 662 of file gnuplot.cc.

◆ Function3d() [2/2]

ns3::Gnuplot3dFunction::Function3d::Function3d	(	const std::string &	title,
		const std::string &	function
	)

Initializes with the function and title.

Parameters

title	Title of the plot
function	Function to plot

Member Function Documentation

◆ GetCommand() [1/2]

std::string ns3::Gnuplot3dFunction::Function3d::GetCommand ( ) const

overridevirtual

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

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

Implements ns3::GnuplotDataset::Data.

Definition at line 669 of file gnuplot.cc.

◆ GetCommand() [2/2]

std::string ns3::Gnuplot3dFunction::Function3d::GetCommand ( ) const

overridevirtual

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

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

Implements ns3::GnuplotDataset::Data.

◆ IsEmpty() [1/2]

bool ns3::Gnuplot3dFunction::Function3d::IsEmpty ( ) const

overridevirtual

Checks to see if this GnuplotDataset is empty.

Returns: indicates if this GnuplotDataset is empty.

Implements ns3::GnuplotDataset::Data.

Definition at line 699 of file gnuplot.cc.

◆ IsEmpty() [2/2]

bool ns3::Gnuplot3dFunction::Function3d::IsEmpty ( ) const

overridevirtual

Checks to see if this GnuplotDataset is empty.

Returns: indicates if this GnuplotDataset is empty.

Implements ns3::GnuplotDataset::Data.

◆ PrintDataFile() [1/2]

void ns3::Gnuplot3dFunction::Function3d::PrintDataFile	(	std::ostream &	os,
		bool	generateOneOutputFile
	)		const

overridevirtual

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

◆ PrintDataFile() [2/2]

void ns3::Gnuplot3dFunction::Function3d::PrintDataFile	(	std::ostream &	os,
		bool	generateOneOutputFile
	)		const

overridevirtual

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.

◆ PrintExpression() [1/2]

void ns3::Gnuplot3dFunction::Function3d::PrintExpression	(	std::ostream &	os,
		bool	generateOneOutputFile,
		unsigned int	dataFileDatasetIndex,
		std::string &	dataFileName
	)		const

overridevirtual

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

◆ PrintExpression() [2/2]

void ns3::Gnuplot3dFunction::Function3d::PrintExpression	(	std::ostream &	os,
		bool	generateOneOutputFile,
		unsigned int	dataFileDatasetIndex,
		std::string &	dataFileName
	)		const

overridevirtual

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.

Member Data Documentation

◆ m_function

std::string ns3::Gnuplot3dFunction::Function3d::m_function

Function to use.

Definition at line 643 of file gnuplot.cc.

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

src/stats/model/gnuplot.cc
src/stats/model/gnuplot_new.cc

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Function3d() [1/2]

◆ Function3d() [2/2]

Member Function Documentation

◆ GetCommand() [1/2]

◆ GetCommand() [2/2]

◆ IsEmpty() [1/2]

◆ IsEmpty() [2/2]

◆ PrintDataFile() [1/2]

◆ PrintDataFile() [2/2]

◆ PrintExpression() [1/2]

◆ PrintExpression() [2/2]

Member Data Documentation

◆ m_function