Class for output file stream container for strings. More...

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

Inheritance diagram for ns3::SatOutputFileStreamStringContainer:

Collaboration diagram for ns3::SatOutputFileStreamStringContainer:

Public Member Functions
	SatOutputFileStreamStringContainer ()
	Constructor.
	SatOutputFileStreamStringContainer (std::string filename, std::ios::openmode filemode)
	Constructor.
	~SatOutputFileStreamStringContainer ()
	Destructor.
void	AddToContainer (std::string newLine)
	Function for adding the line to container.
void	DoDispose ()
	Do needed dispose actions.
void	WriteContainerToFile ()
	Function for writing the container contents to file.

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

Private Member Functions
void	ClearContainer ()
	Function for clearing the container.
void	OpenStream ()
	Function for opening the output file stream.
void	Reset ()
	Function for resetting the variables.
void	ResetStream ()
	Function for resetting the stream.

Private Attributes
std::vector< std::string >	m_container
	Container for lines.
std::ios::openmode	m_fileMode
	File mode.
std::string	m_fileName
	File name.
std::ofstream *	m_outputFileStream
	Pointer to output file stream.
SatOutputFileStreamWrapper *	m_outputFileStreamWrapper
	Pointer to output file stream wrapper.

Detailed Description

Class for output file stream container for strings.

The class implements storing the values and writing the stored values into a file.

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

Constructor & Destructor Documentation

◆ SatOutputFileStreamStringContainer() [1/2]

ns3::SatOutputFileStreamStringContainer::SatOutputFileStreamStringContainer	(	std::string	filename,
		std::ios::openmode	filemode )

Constructor.

Parameters

filename	file name
filemode	file mode

Definition at line 43 of file satellite-output-fstream-string-container.cc.

References m_container, m_fileMode, m_fileName, m_outputFileStream, and m_outputFileStreamWrapper.

◆ SatOutputFileStreamStringContainer() [2/2]

ns3::SatOutputFileStreamStringContainer::SatOutputFileStreamStringContainer ( )

Constructor.

Definition at line 54 of file satellite-output-fstream-string-container.cc.

References m_container, m_fileMode, m_fileName, m_outputFileStream, and m_outputFileStreamWrapper.

◆ ~SatOutputFileStreamStringContainer()

ns3::SatOutputFileStreamStringContainer::~SatOutputFileStreamStringContainer ( )

Destructor.

Definition at line 66 of file satellite-output-fstream-string-container.cc.

References Reset().

Here is the call graph for this function:

Member Function Documentation

◆ AddToContainer()

void ns3::SatOutputFileStreamStringContainer::AddToContainer ( std::string newLine )

Function for adding the line to container.

Definition at line 106 of file satellite-output-fstream-string-container.cc.

References m_container.

◆ ClearContainer()

void ns3::SatOutputFileStreamStringContainer::ClearContainer ( )

private

Function for clearing the container.

Definition at line 148 of file satellite-output-fstream-string-container.cc.

References m_container.

Referenced by Reset().

Here is the caller graph for this function:

◆ DoDispose()

void ns3::SatOutputFileStreamStringContainer::DoDispose ( )

Do needed dispose actions.

Definition at line 74 of file satellite-output-fstream-string-container.cc.

References Reset().

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::SatOutputFileStreamStringContainer::GetTypeId ( void )

static

NS-3 function for type id.

Returns: type id

Definition at line 35 of file satellite-output-fstream-string-container.cc.

◆ OpenStream()

void ns3::SatOutputFileStreamStringContainer::OpenStream ( )

private

Function for opening the output file stream.

Definition at line 114 of file satellite-output-fstream-string-container.cc.

References m_fileMode, m_fileName, m_outputFileStream, and m_outputFileStreamWrapper.

Referenced by WriteContainerToFile().

Here is the caller graph for this function:

◆ Reset()

void ns3::SatOutputFileStreamStringContainer::Reset ( )

private

Function for resetting the variables.

Definition at line 123 of file satellite-output-fstream-string-container.cc.

References ClearContainer(), and ResetStream().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ResetStream()

void ns3::SatOutputFileStreamStringContainer::ResetStream ( )

private

Function for resetting the stream.

Definition at line 132 of file satellite-output-fstream-string-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::SatOutputFileStreamStringContainer::WriteContainerToFile ( )

Function for writing the container contents to file.

Definition at line 83 of file satellite-output-fstream-string-container.cc.

References m_container, m_outputFileStream, OpenStream(), and Reset().

Here is the call graph for this function:

Member Data Documentation

◆ m_container

std::vector<std::string> ns3::SatOutputFileStreamStringContainer::m_container

private

Container for lines.

Definition at line 116 of file satellite-output-fstream-string-container.h.

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

◆ m_fileMode

std::ios::openmode ns3::SatOutputFileStreamStringContainer::m_fileMode

private

File mode.

Definition at line 126 of file satellite-output-fstream-string-container.h.

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

◆ m_fileName

std::string ns3::SatOutputFileStreamStringContainer::m_fileName

private

File name.

Definition at line 121 of file satellite-output-fstream-string-container.h.

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

◆ m_outputFileStream

std::ofstream* ns3::SatOutputFileStreamStringContainer::m_outputFileStream

private

Pointer to output file stream.

Definition at line 111 of file satellite-output-fstream-string-container.h.

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

◆ m_outputFileStreamWrapper

SatOutputFileStreamWrapper* ns3::SatOutputFileStreamStringContainer::m_outputFileStreamWrapper

private

Pointer to output file stream wrapper.

Definition at line 106 of file satellite-output-fstream-string-container.h.

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

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

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SatOutputFileStreamStringContainer() [1/2]

◆ SatOutputFileStreamStringContainer() [2/2]

◆ ~SatOutputFileStreamStringContainer()

Member Function Documentation

◆ AddToContainer()

◆ ClearContainer()

◆ DoDispose()

◆ GetTypeId()

◆ OpenStream()

◆ Reset()

◆ ResetStream()

◆ WriteContainerToFile()

Member Data Documentation

◆ m_container

◆ m_fileMode

◆ m_fileName

◆ m_outputFileStream

◆ m_outputFileStreamWrapper