BmnFileReaderRaw Class Reference

#include <BmnFileReaderRaw.h>

Inheritance diagram for BmnFileReaderRaw:

Collaboration diagram for BmnFileReaderRaw:

Public Member Functions
	BmnFileReaderRaw (const std::string &fileName="")
	BmnFileReaderRaw (std::string &&fileName)
	BmnFileReaderRaw (const std::filesystem::path &filePath)
	BmnFileReaderRaw (std::filesystem::path &&filePath)
virtual	~BmnFileReaderRaw ()=default
	BmnFileReaderRaw (const BmnFileReaderRaw &)=delete
BmnFileReaderRaw &	operator= (const BmnFileReaderRaw &)=delete
	BmnFileReaderRaw (BmnFileReaderRaw &&) noexcept=delete
BmnFileReaderRaw &	operator= (BmnFileReaderRaw &&) noexcept=delete
virtual void	Open (const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary) override
virtual void	Close () noexcept override
virtual int64_t	Read (void *dataToFill, const int64_t sizeToFill) override
virtual int64_t	Tell () const noexcept override
virtual void	Seek (int64_t value) override
virtual bool	IsGood () const noexcept override
virtual bool	IsEOF () const noexcept override
virtual void	ClearStateFlags () override
virtual bool	IsOpen () const noexcept override
	BmnFileReaderRaw (const std::string &fileName="")
	BmnFileReaderRaw (std::string &&fileName)
	BmnFileReaderRaw (const std::filesystem::path &filePath)
	BmnFileReaderRaw (std::filesystem::path &&filePath)
virtual	~BmnFileReaderRaw ()=default
	BmnFileReaderRaw (const BmnFileReaderRaw &)=delete
BmnFileReaderRaw &	operator= (const BmnFileReaderRaw &)=delete
	BmnFileReaderRaw (BmnFileReaderRaw &&) noexcept=delete
BmnFileReaderRaw &	operator= (BmnFileReaderRaw &&) noexcept=delete
virtual void	Open (const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary) override
virtual void	Close () noexcept override
virtual int64_t	Read (void *dataToFill, const int64_t sizeToFill) override
virtual int64_t	Tell () const noexcept override
virtual void	Seek (int64_t value) override
virtual bool	IsGood () const noexcept override
virtual bool	IsEOF () const noexcept override
virtual void	ClearStateFlags () override
virtual bool	IsOpen () const noexcept override
Public Member Functions inherited from BmnIFileReader
	BmnIFileReader (const BmnFileType fileType, const std::string &fileName="")
	BmnIFileReader (const BmnFileType fileType, std::string &&fileName) noexcept
	BmnIFileReader (const BmnFileType fileType, const std::filesystem::path &filePath)
	BmnIFileReader (const BmnFileType fileType, std::filesystem::path &&filePath) noexcept
virtual	~BmnIFileReader ()=default
	BmnIFileReader (const BmnIFileReader &)=delete
BmnIFileReader &	operator= (const BmnIFileReader &)=delete
	BmnIFileReader (BmnIFileReader &&) noexcept=delete
BmnIFileReader &	operator= (BmnIFileReader &&) noexcept=delete
virtual void	Open (const std::string &fileName, const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)
virtual void	Open (std::string &&fileName, const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)
virtual void	Open (const std::filesystem::path &filePath, const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)
virtual void	Open (std::filesystem::path &&filePath, const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)
void	SetFilePath (const std::string &fileName)
void	SetFilePath (std::string &&fileName) noexcept
void	SetFilePath (const std::filesystem::path &filePath)
void	SetFilePath (std::filesystem::path &&filePath) noexcept
std::filesystem::path &	GetFilePath () noexcept
const std::filesystem::path &	GetFilePath () const noexcept
int64_t	GetInputFileSize () const
void	SetProcessingFlags (const BmnBinaryFileProcessingOptions) noexcept
void	AddProcessingFlags (const BmnBinaryFileProcessingOptions) noexcept
void	RemoveProcessingFlags (const BmnBinaryFileProcessingOptions) noexcept
BmnBinaryFileProcessingOptions	GetProcessingFlags () const noexcept
BmnFileType	GetFileType () const noexcept
	BmnIFileReader (const BmnFileType fileType, const std::string &fileName="")
	BmnIFileReader (const BmnFileType fileType, std::string &&fileName) noexcept
	BmnIFileReader (const BmnFileType fileType, const std::filesystem::path &filePath)
	BmnIFileReader (const BmnFileType fileType, std::filesystem::path &&filePath) noexcept
virtual	~BmnIFileReader ()=default
	BmnIFileReader (const BmnIFileReader &)=delete
BmnIFileReader &	operator= (const BmnIFileReader &)=delete
	BmnIFileReader (BmnIFileReader &&) noexcept=delete
BmnIFileReader &	operator= (BmnIFileReader &&) noexcept=delete
virtual void	Open (const std::string &fileName, const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)
virtual void	Open (std::string &&fileName, const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)
virtual void	Open (const std::filesystem::path &filePath, const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)
virtual void	Open (std::filesystem::path &&filePath, const BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)
void	SetFilePath (const std::string &fileName)
void	SetFilePath (std::string &&fileName) noexcept
void	SetFilePath (const std::filesystem::path &filePath)
void	SetFilePath (std::filesystem::path &&filePath) noexcept
std::filesystem::path &	GetFilePath () noexcept
const std::filesystem::path &	GetFilePath () const noexcept
int64_t	GetInputFileSize () const
void	SetProcessingFlags (const BmnBinaryFileProcessingOptions) noexcept
void	AddProcessingFlags (const BmnBinaryFileProcessingOptions) noexcept
void	RemoveProcessingFlags (const BmnBinaryFileProcessingOptions) noexcept
BmnBinaryFileProcessingOptions	GetProcessingFlags () const noexcept
BmnFileType	GetFileType () const noexcept

Private Attributes
std::ifstream	fInputStream
int64_t	fNextByteToRead

Additional Inherited Members
Protected Member Functions inherited from BmnIFileReader
bool	PerformStandardChecksBeforeOpening (const BmnBinaryFileProcessingOptions processingFlags)
bool	PerformStandardChecksBeforeOpening (const BmnBinaryFileProcessingOptions processingFlags)
Protected Attributes inherited from BmnIFileReader
std::filesystem::path	fFilePath
BmnBinaryFileProcessingOptions	fProcessingFlags
BmnFileType	fFileType

Detailed Description

Definition at line 15 of file BmnFileReaderRaw.h.

Constructor & Destructor Documentation

BmnFileReaderRaw() [1/12]

BmnFileReaderRaw::BmnFileReaderRaw ( const std::string & fileName = "" )

explicit

Definition at line 8 of file BmnFileReaderRaw.cxx.

References BmnIFileReader::BmnIFileReader(), fInputStream, and fNextByteToRead.

Referenced by BmnFileReaderRaw(), BmnFileReaderRaw(), operator=(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

BmnFileReaderRaw() [2/12]

BmnFileReaderRaw::BmnFileReaderRaw ( std::string && fileName )

explicit

Definition at line 14 of file BmnFileReaderRaw.cxx.

References BmnIFileReader::BmnIFileReader(), fInputStream, and fNextByteToRead.

Here is the call graph for this function:

BmnFileReaderRaw() [3/12]

BmnFileReaderRaw::BmnFileReaderRaw ( const std::filesystem::path & filePath )

explicit

Definition at line 20 of file BmnFileReaderRaw.cxx.

References BmnIFileReader::BmnIFileReader(), fInputStream, and fNextByteToRead.

Here is the call graph for this function:

BmnFileReaderRaw() [4/12]

BmnFileReaderRaw::BmnFileReaderRaw ( std::filesystem::path && filePath )

explicit

Definition at line 26 of file BmnFileReaderRaw.cxx.

References BmnIFileReader::BmnIFileReader(), fInputStream, and fNextByteToRead.

Here is the call graph for this function:

~BmnFileReaderRaw() [1/2]

virtual BmnFileReaderRaw::~BmnFileReaderRaw ( )

virtualdefault

BmnFileReaderRaw() [5/12]

BmnFileReaderRaw::BmnFileReaderRaw ( const BmnFileReaderRaw & )

delete

References BmnFileReaderRaw().

Here is the call graph for this function:

BmnFileReaderRaw() [6/12]

BmnFileReaderRaw::BmnFileReaderRaw ( BmnFileReaderRaw && )

deletenoexcept

References BmnFileReaderRaw().

Here is the call graph for this function:

BmnFileReaderRaw() [7/12]

BmnFileReaderRaw::BmnFileReaderRaw ( const std::string & fileName = "" )

explicit

BmnFileReaderRaw() [8/12]

BmnFileReaderRaw::BmnFileReaderRaw ( std::string && fileName )

explicit

BmnFileReaderRaw() [9/12]

BmnFileReaderRaw::BmnFileReaderRaw ( const std::filesystem::path & filePath )

explicit

BmnFileReaderRaw() [10/12]

BmnFileReaderRaw::BmnFileReaderRaw ( std::filesystem::path && filePath )

explicit

~BmnFileReaderRaw() [2/2]

virtual BmnFileReaderRaw::~BmnFileReaderRaw ( )

virtualdefault

BmnFileReaderRaw() [11/12]

BmnFileReaderRaw::BmnFileReaderRaw ( const BmnFileReaderRaw & )

delete

References BmnFileReaderRaw().

Here is the call graph for this function:

BmnFileReaderRaw() [12/12]

BmnFileReaderRaw::BmnFileReaderRaw ( BmnFileReaderRaw && )

deletenoexcept

References BmnFileReaderRaw().

Here is the call graph for this function:

Member Function Documentation

ClearStateFlags() [1/2]

void BmnFileReaderRaw::ClearStateFlags ( )

overridevirtual

Implements BmnIFileReader.

Definition at line 83 of file BmnFileReaderRaw.cxx.

References fInputStream.

Referenced by ClearStateFlags(), and operator=().

Here is the caller graph for this function:

ClearStateFlags() [2/2]

virtual void BmnFileReaderRaw::ClearStateFlags ( )

overridevirtual

Implements BmnIFileReader.

References ClearStateFlags().

Here is the call graph for this function:

Close() [1/2]

void BmnFileReaderRaw::Close ( )

overridevirtualnoexcept

Implements BmnIFileReader.

Definition at line 45 of file BmnFileReaderRaw.cxx.

References fInputStream, and fNextByteToRead.

Referenced by Close(), and operator=().

Here is the caller graph for this function:

Close() [2/2]

virtual void BmnFileReaderRaw::Close ( )

overridevirtualnoexcept

Implements BmnIFileReader.

References Close().

Here is the call graph for this function:

IsEOF() [1/2]

bool BmnFileReaderRaw::IsEOF ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

Definition at line 78 of file BmnFileReaderRaw.cxx.

References fInputStream.

Referenced by IsEOF(), and operator=().

Here is the caller graph for this function:

IsEOF() [2/2]

virtual bool BmnFileReaderRaw::IsEOF ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

References IsEOF().

Here is the call graph for this function:

IsGood() [1/2]

bool BmnFileReaderRaw::IsGood ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

Definition at line 73 of file BmnFileReaderRaw.cxx.

References fInputStream.

Referenced by IsGood(), and operator=().

Here is the caller graph for this function:

IsGood() [2/2]

virtual bool BmnFileReaderRaw::IsGood ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

References IsGood().

Here is the call graph for this function:

IsOpen() [1/2]

bool BmnFileReaderRaw::IsOpen ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

Definition at line 88 of file BmnFileReaderRaw.cxx.

References fInputStream.

Referenced by IsOpen(), and operator=().

Here is the caller graph for this function:

IsOpen() [2/2]

virtual bool BmnFileReaderRaw::IsOpen ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

References fInputStream, fNextByteToRead, and IsOpen().

Here is the call graph for this function:

Open() [1/2]

void BmnFileReaderRaw::Open ( const BmnBinaryFileProcessingOptions processingFlags = BmnBinaryFileProcessingOptions::ReadBinary )

overridevirtual

Implements BmnIFileReader.

Definition at line 34 of file BmnFileReaderRaw.cxx.

References BmnIFileReader::fFilePath, fInputStream, and BmnIFileReader::PerformStandardChecksBeforeOpening().

Referenced by Open(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

Open() [2/2]

virtual void BmnFileReaderRaw::Open ( const BmnBinaryFileProcessingOptions processingFlags = BmnBinaryFileProcessingOptions::ReadBinary )

overridevirtual

Implements BmnIFileReader.

References Open().

Here is the call graph for this function:

operator=() [1/4]

BmnFileReaderRaw & BmnFileReaderRaw::operator= ( BmnFileReaderRaw && )

deletenoexcept

References BmnFileReaderRaw(), ClearStateFlags(), Close(), IsEOF(), IsGood(), IsOpen(), Open(), Read(), Seek(), and Tell().

Here is the call graph for this function:

operator=() [2/4]

BmnFileReaderRaw & BmnFileReaderRaw::operator= ( BmnFileReaderRaw && )

deletenoexcept

References BmnFileReaderRaw().

Here is the call graph for this function:

operator=() [3/4]

BmnFileReaderRaw & BmnFileReaderRaw::operator= ( const BmnFileReaderRaw & )

delete

References BmnFileReaderRaw().

Here is the call graph for this function:

operator=() [4/4]

BmnFileReaderRaw & BmnFileReaderRaw::operator= ( const BmnFileReaderRaw & )

delete

References BmnFileReaderRaw().

Here is the call graph for this function:

Read() [1/2]

int64_t BmnFileReaderRaw::Read ( void * dataToFill, const int64_t sizeToFill )

overridevirtual

Implements BmnIFileReader.

Definition at line 51 of file BmnFileReaderRaw.cxx.

References fInputStream, and fNextByteToRead.

Referenced by operator=(), and Read().

Here is the caller graph for this function:

Read() [2/2]

virtual int64_t BmnFileReaderRaw::Read ( void * dataToFill, const int64_t sizeToFill )

overridevirtual

Implements BmnIFileReader.

References Read().

Here is the call graph for this function:

Seek() [1/2]

void BmnFileReaderRaw::Seek ( int64_t value )

overridevirtual

Implements BmnIFileReader.

Definition at line 64 of file BmnFileReaderRaw.cxx.

References fInputStream, and fNextByteToRead.

Referenced by operator=(), and Seek().

Here is the caller graph for this function:

Seek() [2/2]

virtual void BmnFileReaderRaw::Seek ( int64_t value )

overridevirtual

Implements BmnIFileReader.

References Seek().

Here is the call graph for this function:

Tell() [1/2]

int64_t BmnFileReaderRaw::Tell ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

Definition at line 59 of file BmnFileReaderRaw.cxx.

References fNextByteToRead.

Referenced by operator=(), and Tell().

Here is the caller graph for this function:

Tell() [2/2]

virtual int64_t BmnFileReaderRaw::Tell ( ) const

nodiscardoverridevirtualnoexcept

Implements BmnIFileReader.

References Tell().

Here is the call graph for this function:

Member Data Documentation

fInputStream

std::ifstream BmnFileReaderRaw::fInputStream

private

Definition at line 123 of file BmnFileReaderRaw.h.

Referenced by BmnFileReaderRaw(), BmnFileReaderRaw(), BmnFileReaderRaw(), BmnFileReaderRaw(), ClearStateFlags(), Close(), IsEOF(), IsGood(), IsOpen(), Open(), Read(), and Seek().

fNextByteToRead

int64_t BmnFileReaderRaw::fNextByteToRead

private

Definition at line 124 of file BmnFileReaderRaw.h.

Referenced by BmnFileReaderRaw(), BmnFileReaderRaw(), BmnFileReaderRaw(), BmnFileReaderRaw(), Close(), IsOpen(), Read(), Seek(), and Tell().

---

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

• compression/include/BmnFileReaderRaw.h
• install/include/BmnFileReaderRaw.h
• compression/sources/BmnFileReaderRaw.cxx