Class for output file stream container for double values. More...

#include "satellite-output-fstream-double-container.h"

Inheritance diagram for ns3::SatOutputFileStreamDoubleContainer:

Collaboration diagram for ns3::SatOutputFileStreamDoubleContainer:

Public Types
enum	FigureUnitConversion_t { RAW , DECIBEL , DECIBEL_AMPLITUDE }

Public Member Functions
	SatOutputFileStreamDoubleContainer ()
	Constructor. More...

	SatOutputFileStreamDoubleContainer (std::string filename, std::ios::openmode filemode, uint32_t valuesInRow)
	Constructor. More...

	~SatOutputFileStreamDoubleContainer ()
	Destructor. More...

void	AddToContainer (std::vector< double > newItem)
	Function for adding the values to container. More...

void	DoDispose ()
	Do needed dispose actions. More...

void	EnableFigureOutput (std::string title, std::string legendY, std::string legendX, std::string keyPosition, FigureUnitConversion_t figureUnitConversionType, Gnuplot2dDataset::Style style)
	Function for enabling the figure output. More...

void	WriteContainerToFile ()
	Function for writing the container contents to file. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	NS-3 function for type id. More...

Private Member Functions
void	ClearContainer ()
	Function for clearing the container. More...

double	ConvertValue (double value)
	Function for converting the container data samples. More...

Gnuplot	GetGnuplot ()
	Function for creating Gnuplots. More...

Gnuplot2dDataset	GetGnuplotDataset ()
	Function for creating Gnuplot datasets. More...

void	OpenStream ()
	Function for opening the output file stream. More...

void	PrintFigure ()
	Function for printing the container contents into a figure. More...

void	Reset ()
	Function for resetting the variables. More...

void	ResetStream ()
	Function for resetting the stream. More...

Private Attributes
std::vector< std::vector< double > >	m_container
	Container for value rows. More...

FigureUnitConversion_t	m_figureUnitConversionType
	Describes which unit conversion should be used with the figure. More...

std::ios::openmode	m_fileMode
	File mode. More...

std::string	m_fileName
	File name. More...

std::string	m_keyPosition
	Figure legend position. More...

std::string	m_legendX
	Figure X-axis title. More...

std::string	m_legendY
	Figure Y-axis title. More...

std::ofstream *	m_outputFileStream
	Pointer to output file stream. More...

SatOutputFileStreamWrapper *	m_outputFileStreamWrapper
	Pointer to output file stream wrapper. More...

bool	m_printFigure
	Enable / disable printing of container contents into a figure. More...

Gnuplot2dDataset::Style	m_style
	2D dataset figure style More...

std::string	m_title
	Figure title. More...

uint32_t	m_valuesInRow
	Number of values in a row. More...

Detailed Description

Class for output file stream container for double values.

The class implements storing the values and writing the stored values into a file. A figure output in two dimensions is also supported.

Definition at line 41 of file satellite-output-fstream-double-container.h.

Member Enumeration Documentation

◆ FigureUnitConversion_t

enum ns3::SatOutputFileStreamDoubleContainer::FigureUnitConversion_t

Enumerator
RAW
DECIBEL
DECIBEL_AMPLITUDE

Definition at line 44 of file satellite-output-fstream-double-container.h.

Constructor & Destructor Documentation

◆ SatOutputFileStreamDoubleContainer() [1/2]

ns3::SatOutputFileStreamDoubleContainer::SatOutputFileStreamDoubleContainer	(	std::string	filename,
		std::ios::openmode	filemode,
		uint32_t	valuesInRow
	)

Constructor.

Parameters

filename	file name
filemode	file mode
valuesInRow	number of values in a row

Definition at line 41 of file satellite-output-fstream-double-container.cc.

References m_fileMode, m_fileName, and m_valuesInRow.

◆ SatOutputFileStreamDoubleContainer() [2/2]

ns3::SatOutputFileStreamDoubleContainer::SatOutputFileStreamDoubleContainer ( )

Constructor.

Definition at line 63 of file satellite-output-fstream-double-container.cc.

◆ ~SatOutputFileStreamDoubleContainer()

ns3::SatOutputFileStreamDoubleContainer::~SatOutputFileStreamDoubleContainer ( )

Destructor.

Definition at line 79 of file satellite-output-fstream-double-container.cc.

References Reset().

Here is the call graph for this function:

Member Function Documentation

◆ AddToContainer()

void ns3::SatOutputFileStreamDoubleContainer::AddToContainer ( std::vector< double > newItem )

Function for adding the values to container.

Definition at line 160 of file satellite-output-fstream-double-container.cc.

References m_container, and m_valuesInRow.

◆ ClearContainer()

void ns3::SatOutputFileStreamDoubleContainer::ClearContainer ( )

private

Function for clearing the container.

Definition at line 207 of file satellite-output-fstream-double-container.cc.

References m_container, and m_valuesInRow.

Referenced by Reset().

Here is the caller graph for this function:

◆ ConvertValue()

double ns3::SatOutputFileStreamDoubleContainer::ConvertValue ( double value )

private

Function for converting the container data samples.

Parameters

value original data sample value

Returns: converted data sample value

Definition at line 257 of file satellite-output-fstream-double-container.cc.

References DECIBEL, DECIBEL_AMPLITUDE, m_figureUnitConversionType, and RAW.

Referenced by GetGnuplotDataset().

Here is the caller graph for this function:

◆ DoDispose()

void ns3::SatOutputFileStreamDoubleContainer::DoDispose ( void )

Do needed dispose actions.

Definition at line 87 of file satellite-output-fstream-double-container.cc.

References Reset().

Here is the call graph for this function:

◆ EnableFigureOutput()

void ns3::SatOutputFileStreamDoubleContainer::EnableFigureOutput	(	std::string	title,
		std::string	legendY,
		std::string	legendX,
		std::string	keyPosition,
		FigureUnitConversion_t	figureUnitConversionType,
		Gnuplot2dDataset::Style	style
	)

Function for enabling the figure output.

Parameters

title	title text
legendY	Y-axis title
legendX	X-axis title
keyPosition	Legend position
figureUnitConversionType	Conversion type for units in the figure
style	2D dataset figure style

Definition at line 303 of file satellite-output-fstream-double-container.cc.

References m_figureUnitConversionType, m_keyPosition, m_legendX, m_legendY, m_printFigure, m_style, and m_title.

◆ GetGnuplot()

Gnuplot ns3::SatOutputFileStreamDoubleContainer::GetGnuplot ( )

private

Function for creating Gnuplots.

Returns: Gnuplot

Definition at line 289 of file satellite-output-fstream-double-container.cc.

References m_fileName, m_keyPosition, m_legendX, m_legendY, and m_title.

Referenced by PrintFigure().

Here is the caller graph for this function:

◆ GetGnuplotDataset()

Gnuplot2dDataset ns3::SatOutputFileStreamDoubleContainer::GetGnuplotDataset ( )

private

Function for creating Gnuplot datasets.

Returns: dataset

Definition at line 227 of file satellite-output-fstream-double-container.cc.

References ConvertValue(), m_container, m_style, m_title, and m_valuesInRow.

Referenced by PrintFigure().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::SatOutputFileStreamDoubleContainer::GetTypeId ( void )

static

NS-3 function for type id.

Returns: type id

Definition at line 33 of file satellite-output-fstream-double-container.cc.

◆ OpenStream()

void ns3::SatOutputFileStreamDoubleContainer::OpenStream ( )

private

Function for opening the output file stream.

Definition at line 173 of file satellite-output-fstream-double-container.cc.

References ns3::SatOutputFileStreamWrapper::GetStream(), m_fileMode, m_fileName, m_outputFileStream, and m_outputFileStreamWrapper.

Referenced by WriteContainerToFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PrintFigure()

void ns3::SatOutputFileStreamDoubleContainer::PrintFigure ( )

private

Function for printing the container contents into a figure.

Definition at line 135 of file satellite-output-fstream-double-container.cc.

References GetGnuplot(), GetGnuplotDataset(), and m_fileName.

Referenced by WriteContainerToFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Reset()

void ns3::SatOutputFileStreamDoubleContainer::Reset ( void )

private

Function for resetting the variables.

Definition at line 182 of file satellite-output-fstream-double-container.cc.

References ClearContainer(), and ResetStream().

Referenced by ~SatOutputFileStreamDoubleContainer(), DoDispose(), and WriteContainerToFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ResetStream()

void ns3::SatOutputFileStreamDoubleContainer::ResetStream ( )

private

Function for resetting the stream.

Definition at line 191 of file satellite-output-fstream-double-container.cc.

References m_fileMode, m_fileName, m_outputFileStream, and m_outputFileStreamWrapper.

Referenced by Reset().

Here is the caller graph for this function:

◆ WriteContainerToFile()

void ns3::SatOutputFileStreamDoubleContainer::WriteContainerToFile ( )

Function for writing the container contents to file.

Definition at line 96 of file satellite-output-fstream-double-container.cc.

References m_container, m_outputFileStream, m_printFigure, m_valuesInRow, OpenStream(), PrintFigure(), and Reset().

Here is the call graph for this function:

Member Data Documentation

◆ m_container

std::vector<std::vector<double> > ns3::SatOutputFileStreamDoubleContainer::m_container

private

Container for value rows.

Definition at line 166 of file satellite-output-fstream-double-container.h.

Referenced by AddToContainer(), ClearContainer(), GetGnuplotDataset(), and WriteContainerToFile().

◆ m_figureUnitConversionType

FigureUnitConversion_t ns3::SatOutputFileStreamDoubleContainer::m_figureUnitConversionType

private

Describes which unit conversion should be used with the figure.

Definition at line 211 of file satellite-output-fstream-double-container.h.

Referenced by ConvertValue(), and EnableFigureOutput().

◆ m_fileMode

std::ios::openmode ns3::SatOutputFileStreamDoubleContainer::m_fileMode

private

File mode.

Definition at line 176 of file satellite-output-fstream-double-container.h.

Referenced by SatOutputFileStreamDoubleContainer(), OpenStream(), and ResetStream().

◆ m_fileName

std::string ns3::SatOutputFileStreamDoubleContainer::m_fileName

private

File name.

Definition at line 171 of file satellite-output-fstream-double-container.h.

Referenced by SatOutputFileStreamDoubleContainer(), GetGnuplot(), OpenStream(), PrintFigure(), and ResetStream().

◆ m_keyPosition

std::string ns3::SatOutputFileStreamDoubleContainer::m_keyPosition

private

Figure legend position.

Definition at line 206 of file satellite-output-fstream-double-container.h.

Referenced by EnableFigureOutput(), and GetGnuplot().

◆ m_legendX

std::string ns3::SatOutputFileStreamDoubleContainer::m_legendX

private

Figure X-axis title.

Definition at line 201 of file satellite-output-fstream-double-container.h.

Referenced by EnableFigureOutput(), and GetGnuplot().

◆ m_legendY

std::string ns3::SatOutputFileStreamDoubleContainer::m_legendY

private

Figure Y-axis title.

Definition at line 196 of file satellite-output-fstream-double-container.h.

Referenced by EnableFigureOutput(), and GetGnuplot().

◆ m_outputFileStream

std::ofstream* ns3::SatOutputFileStreamDoubleContainer::m_outputFileStream

private

Pointer to output file stream.

Definition at line 161 of file satellite-output-fstream-double-container.h.

Referenced by OpenStream(), ResetStream(), and WriteContainerToFile().

◆ m_outputFileStreamWrapper

SatOutputFileStreamWrapper* ns3::SatOutputFileStreamDoubleContainer::m_outputFileStreamWrapper

private

Pointer to output file stream wrapper.

Definition at line 156 of file satellite-output-fstream-double-container.h.

Referenced by OpenStream(), and ResetStream().

◆ m_printFigure

bool ns3::SatOutputFileStreamDoubleContainer::m_printFigure

private

Enable / disable printing of container contents into a figure.

Definition at line 186 of file satellite-output-fstream-double-container.h.

Referenced by EnableFigureOutput(), and WriteContainerToFile().

◆ m_style

Gnuplot2dDataset::Style ns3::SatOutputFileStreamDoubleContainer::m_style

private

2D dataset figure style

Definition at line 216 of file satellite-output-fstream-double-container.h.

Referenced by EnableFigureOutput(), and GetGnuplotDataset().

◆ m_title

std::string ns3::SatOutputFileStreamDoubleContainer::m_title

private

Figure title.

Definition at line 191 of file satellite-output-fstream-double-container.h.

Referenced by EnableFigureOutput(), GetGnuplot(), and GetGnuplotDataset().

◆ m_valuesInRow

uint32_t ns3::SatOutputFileStreamDoubleContainer::m_valuesInRow

private

Number of values in a row.

Definition at line 181 of file satellite-output-fstream-double-container.h.

Referenced by SatOutputFileStreamDoubleContainer(), AddToContainer(), ClearContainer(), GetGnuplotDataset(), and WriteContainerToFile().

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

/builds/sns3/satellite/satellite/utils/satellite-output-fstream-double-container.h
/builds/sns3/satellite/satellite/utils/satellite-output-fstream-double-container.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ FigureUnitConversion_t

Constructor & Destructor Documentation

◆ SatOutputFileStreamDoubleContainer() [1/2]

◆ SatOutputFileStreamDoubleContainer() [2/2]

◆ ~SatOutputFileStreamDoubleContainer()

Member Function Documentation

◆ AddToContainer()

◆ ClearContainer()

◆ ConvertValue()

◆ DoDispose()

◆ EnableFigureOutput()

◆ GetGnuplot()

◆ GetGnuplotDataset()

◆ GetTypeId()

◆ OpenStream()

◆ PrintFigure()

◆ Reset()

◆ ResetStream()

◆ WriteContainerToFile()

Member Data Documentation

◆ m_container

◆ m_figureUnitConversionType

◆ m_fileMode

◆ m_fileName

◆ m_keyPosition

◆ m_legendX

◆ m_legendY

◆ m_outputFileStream

◆ m_outputFileStreamWrapper

◆ m_printFigure

◆ m_style

◆ m_title

◆ m_valuesInRow