A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::AsciiFile Class Reference

A class representing an ascii file. More...

#include "ascii-file.h"

+ Collaboration diagram for ns3::AsciiFile:

Public Member Functions

 AsciiFile ()
 
 ~AsciiFile ()
 
void Close ()
 Close the underlying file.
 
bool Eof () const
 
bool Fail () const
 
void Open (const std::string &filename, std::ios::openmode mode)
 Create a new ascii file or open an existing ascii file.
 
void Read (std::string &line)
 Read next line from file.
 

Static Public Member Functions

static bool Diff (const std::string &f1, const std::string &f2, uint64_t &lineNumber)
 Compare two ASCII files line-by-line.
 

Private Attributes

std::fstream m_file
 output file
 
std::string m_filename
 output file name
 

Detailed Description

A class representing an ascii file.

This class represents an ascii file

Definition at line 37 of file ascii-file.h.

Constructor & Destructor Documentation

◆ AsciiFile()

ns3::AsciiFile::AsciiFile ( )

Definition at line 38 of file ascii-file.cc.

References m_file, and ns3::FatalImpl::RegisterStream().

+ Here is the call graph for this function:

◆ ~AsciiFile()

ns3::AsciiFile::~AsciiFile ( )

Definition at line 44 of file ascii-file.cc.

References Close(), m_file, and ns3::FatalImpl::UnregisterStream().

+ Here is the call graph for this function:

Member Function Documentation

◆ Close()

void ns3::AsciiFile::Close ( )

Close the underlying file.

Definition at line 63 of file ascii-file.cc.

References m_file.

Referenced by ~AsciiFile().

+ Here is the caller graph for this function:

◆ Diff()

bool ns3::AsciiFile::Diff ( const std::string &  f1,
const std::string &  f2,
uint64_t &  lineNumber 
)
static

Compare two ASCII files line-by-line.

Returns
true if files are different, false otherwise
Parameters
f1First ASCII file name
f2Second ASCII file name
lineNumber[out] Line number of first different line.

Definition at line 87 of file ascii-file.cc.

References Eof(), Fail(), Open(), and Read().

+ Here is the call graph for this function:

◆ Eof()

bool ns3::AsciiFile::Eof ( ) const
Returns
true if the 'eof' bit is set in the underlying iostream, false otherwise.

Definition at line 57 of file ascii-file.cc.

References m_file.

Referenced by Diff().

+ Here is the caller graph for this function:

◆ Fail()

bool ns3::AsciiFile::Fail ( ) const
Returns
true if the 'fail' bit is set in the underlying iostream, false otherwise.

Definition at line 51 of file ascii-file.cc.

References m_file.

Referenced by Diff().

+ Here is the caller graph for this function:

◆ Open()

void ns3::AsciiFile::Open ( const std::string &  filename,
std::ios::openmode  mode 
)

Create a new ascii file or open an existing ascii file.

Parameters
filenameString containing the name of the file.
modethe access mode for the file.

Definition at line 69 of file ascii-file.cc.

References m_file, and NS_ASSERT.

Referenced by Diff().

+ Here is the caller graph for this function:

◆ Read()

void ns3::AsciiFile::Read ( std::string &  line)

Read next line from file.

Parameters
line[out] line from file

Definition at line 78 of file ascii-file.cc.

References m_file, and NS_ASSERT.

Referenced by Diff().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_file

std::fstream ns3::AsciiFile::m_file
private

output file

Definition at line 86 of file ascii-file.h.

Referenced by AsciiFile(), ~AsciiFile(), Close(), Eof(), Fail(), Open(), and Read().

◆ m_filename

std::string ns3::AsciiFile::m_filename
private

output file name

Definition at line 85 of file ascii-file.h.


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