BmnIFileReader Class Reference

#include <BmnIFileReader.h>

Inheritance diagram for BmnIFileReader:

Public Member Functions
	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 BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)=0
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)
virtual void	Close () noexcept=0
virtual int64_t	Read (void *dataPointer, int64_t numberOfBytesToRead)=0
virtual int64_t	Tell () const noexcept=0
virtual void	Seek (int64_t aNewReadingPosition)=0
virtual bool	IsGood () const noexcept=0
virtual bool	IsEOF () const noexcept=0
virtual void	ClearStateFlags ()=0
virtual bool	IsOpen () const noexcept=0
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 BmnBinaryFileProcessingOptions processingFlags=BmnBinaryFileProcessingOptions::ReadBinary)=0
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)
virtual void	Close () noexcept=0
virtual int64_t	Read (void *dataPointer, int64_t numberOfBytesToRead)=0
virtual int64_t	Tell () const noexcept=0
virtual void	Seek (int64_t aNewReadingPosition)=0
virtual bool	IsGood () const noexcept=0
virtual bool	IsEOF () const noexcept=0
virtual void	ClearStateFlags ()=0
virtual bool	IsOpen () const noexcept=0
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

Protected Member Functions
bool	PerformStandardChecksBeforeOpening (const BmnBinaryFileProcessingOptions processingFlags)
bool	PerformStandardChecksBeforeOpening (const BmnBinaryFileProcessingOptions processingFlags)

Protected Attributes
std::filesystem::path	fFilePath
BmnBinaryFileProcessingOptions	fProcessingFlags
BmnFileType	fFileType

Detailed Description

Definition at line 21 of file BmnIFileReader.h.

Constructor & Destructor Documentation

BmnIFileReader() [1/12]

BmnIFileReader::BmnIFileReader ( const BmnFileType fileType, const std::string & fileName = "" )

explicit

Definition at line 8 of file BmnIFileReader.cxx.

References fFilePath, fFileType, and fProcessingFlags.

Referenced by BmnFileReaderRaw::BmnFileReaderRaw(), BmnFileReaderRaw::BmnFileReaderRaw(), BmnFileReaderRaw::BmnFileReaderRaw(), BmnFileReaderRaw::BmnFileReaderRaw(), BmnFileReaderXzLzma::BmnFileReaderXzLzma(), BmnFileReaderXzLzma::BmnFileReaderXzLzma(), BmnFileReaderXzLzma::BmnFileReaderXzLzma(), BmnFileReaderXzLzma::BmnFileReaderXzLzma(), BmnFileReaderZLib::BmnFileReaderZLib(), BmnFileReaderZLib::BmnFileReaderZLib(), BmnFileReaderZLib::BmnFileReaderZLib(), BmnFileReaderZLib::BmnFileReaderZLib(), BmnFileReaderZLibNG::BmnFileReaderZLibNG(), BmnFileReaderZLibNG::BmnFileReaderZLibNG(), BmnFileReaderZLibNG::BmnFileReaderZLibNG(), BmnFileReaderZLibNG::BmnFileReaderZLibNG(), BmnFileReaderZStd::BmnFileReaderZStd(), BmnFileReaderZStd::BmnFileReaderZStd(), BmnFileReaderZStd::BmnFileReaderZStd(), BmnFileReaderZStd::BmnFileReaderZStd(), BmnIFileReader(), BmnIFileReader(), operator=(), operator=(), PerformStandardChecksBeforeOpening(), and SetFilePath().

Here is the caller graph for this function:

BmnIFileReader() [2/12]

BmnIFileReader::BmnIFileReader ( const BmnFileType fileType, std::string && fileName )

explicitnoexcept

Definition at line 14 of file BmnIFileReader.cxx.

References fFilePath, fFileType, fProcessingFlags, and None.

BmnIFileReader() [3/12]

BmnIFileReader::BmnIFileReader ( const BmnFileType fileType, const std::filesystem::path & filePath )

explicit

Definition at line 20 of file BmnIFileReader.cxx.

References fFilePath, fFileType, and fProcessingFlags.

BmnIFileReader() [4/12]

BmnIFileReader::BmnIFileReader ( const BmnFileType fileType, std::filesystem::path && filePath )

explicitnoexcept

Definition at line 26 of file BmnIFileReader.cxx.

References fFilePath, fFileType, fProcessingFlags, and None.

~BmnIFileReader() [1/2]

virtual BmnIFileReader::~BmnIFileReader ( )

virtualdefault

BmnIFileReader() [5/12]

BmnIFileReader::BmnIFileReader ( const BmnIFileReader & )

delete

References BmnIFileReader().

Here is the call graph for this function:

BmnIFileReader() [6/12]

BmnIFileReader::BmnIFileReader ( BmnIFileReader && )

deletenoexcept

References BmnIFileReader().

Here is the call graph for this function:

BmnIFileReader() [7/12]

BmnIFileReader::BmnIFileReader ( const BmnFileType fileType, const std::string & fileName = "" )

explicit

BmnIFileReader() [8/12]

BmnIFileReader::BmnIFileReader ( const BmnFileType fileType, std::string && fileName )

explicitnoexcept

BmnIFileReader() [9/12]

BmnIFileReader::BmnIFileReader ( const BmnFileType fileType, const std::filesystem::path & filePath )

explicit

BmnIFileReader() [10/12]

BmnIFileReader::BmnIFileReader ( const BmnFileType fileType, std::filesystem::path && filePath )

explicitnoexcept

~BmnIFileReader() [2/2]

virtual BmnIFileReader::~BmnIFileReader ( )

virtualdefault

BmnIFileReader() [11/12]

BmnIFileReader::BmnIFileReader ( const BmnIFileReader & )

delete

References BmnIFileReader().

Here is the call graph for this function:

BmnIFileReader() [12/12]

BmnIFileReader::BmnIFileReader ( BmnIFileReader && )

deletenoexcept

References BmnIFileReader().

Here is the call graph for this function:

Member Function Documentation

AddProcessingFlags() [1/2]

void BmnIFileReader::AddProcessingFlags ( const BmnBinaryFileProcessingOptions newFlags )

inlinenoexcept

Definition at line 274 of file BmnIFileReader.h.

References fProcessingFlags, and IsOpen().

Referenced by AddProcessingFlags(), and IsOpen().

Here is the call graph for this function:

Here is the caller graph for this function:

AddProcessingFlags() [2/2]

void BmnIFileReader::AddProcessingFlags ( const BmnBinaryFileProcessingOptions )

inlinenoexcept

References AddProcessingFlags().

Here is the call graph for this function:

ClearStateFlags() [1/2]

virtual void BmnIFileReader::ClearStateFlags ( )

pure virtual

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References ClearStateFlags().

Referenced by ClearStateFlags().

Here is the call graph for this function:

Here is the caller graph for this function:

ClearStateFlags() [2/2]

virtual void BmnIFileReader::ClearStateFlags ( )

pure virtual

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References ClearStateFlags().

Here is the call graph for this function:

Close() [1/2]

virtual void BmnIFileReader::Close ( )

pure virtualnoexcept

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References Close().

Referenced by Close(), and PerformStandardChecksBeforeOpening().

Here is the call graph for this function:

Here is the caller graph for this function:

Close() [2/2]

virtual void BmnIFileReader::Close ( )

pure virtualnoexcept

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References Close().

Here is the call graph for this function:

GetFilePath() [1/4]

const std::filesystem::path & BmnIFileReader::GetFilePath ( ) const

inlinenodiscardnoexcept

Definition at line 253 of file BmnIFileReader.h.

References fFilePath.

GetFilePath() [2/4]

const std::filesystem::path & BmnIFileReader::GetFilePath ( ) const

inlinenodiscardnoexcept

References GetFilePath().

Here is the call graph for this function:

GetFilePath() [3/4]

std::filesystem::path & BmnIFileReader::GetFilePath ( )

inlinenodiscardnoexcept

Definition at line 248 of file BmnIFileReader.h.

References fFilePath.

Referenced by GetFilePath(), GetFilePath(), and IsOpen().

Here is the caller graph for this function:

GetFilePath() [4/4]

std::filesystem::path & BmnIFileReader::GetFilePath ( )

inlinenodiscardnoexcept

References GetFilePath().

Here is the call graph for this function:

GetFileType() [1/2]

BmnFileType BmnIFileReader::GetFileType ( ) const

inlinenodiscardnoexcept

Definition at line 297 of file BmnIFileReader.h.

References fFileType.

Referenced by GetFileType(), and IsOpen().

Here is the caller graph for this function:

GetFileType() [2/2]

BmnFileType BmnIFileReader::GetFileType ( ) const

inlinenodiscardnoexcept

References GetFileType().

Here is the call graph for this function:

GetInputFileSize() [1/2]

int64_t BmnIFileReader::GetInputFileSize ( ) const

inlinenodiscard

Definition at line 258 of file BmnIFileReader.h.

References fFilePath.

Referenced by GetInputFileSize(), and IsOpen().

Here is the caller graph for this function:

GetInputFileSize() [2/2]

int64_t BmnIFileReader::GetInputFileSize ( ) const

inlinenodiscard

References GetInputFileSize().

Here is the call graph for this function:

GetProcessingFlags() [1/2]

BmnBinaryFileProcessingOptions BmnIFileReader::GetProcessingFlags ( ) const

inlinenodiscardnoexcept

Definition at line 292 of file BmnIFileReader.h.

References fProcessingFlags.

Referenced by GetProcessingFlags(), and IsOpen().

Here is the caller graph for this function:

GetProcessingFlags() [2/2]

BmnBinaryFileProcessingOptions BmnIFileReader::GetProcessingFlags ( ) const

inlinenodiscardnoexcept

References GetProcessingFlags().

Here is the call graph for this function:

IsEOF() [1/2]

virtual bool BmnIFileReader::IsEOF ( ) const

nodiscardpure virtualnoexcept

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References IsEOF().

Referenced by IsEOF().

Here is the call graph for this function:

Here is the caller graph for this function:

IsEOF() [2/2]

virtual bool BmnIFileReader::IsEOF ( ) const

nodiscardpure virtualnoexcept

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References IsEOF().

Here is the call graph for this function:

IsGood() [1/2]

virtual bool BmnIFileReader::IsGood ( ) const

nodiscardpure virtualnoexcept

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References IsGood().

Referenced by IsGood().

Here is the call graph for this function:

Here is the caller graph for this function:

IsGood() [2/2]

virtual bool BmnIFileReader::IsGood ( ) const

nodiscardpure virtualnoexcept

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References IsGood().

Here is the call graph for this function:

IsOpen() [1/2]

virtual bool BmnIFileReader::IsOpen ( ) const

nodiscardpure virtualnoexcept

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References AddProcessingFlags(), GetFilePath(), GetFileType(), GetInputFileSize(), GetProcessingFlags(), IsOpen(), PerformStandardChecksBeforeOpening(), RemoveProcessingFlags(), SetFilePath(), and SetProcessingFlags().

Referenced by AddProcessingFlags(), IsOpen(), PerformStandardChecksBeforeOpening(), RemoveProcessingFlags(), SetFilePath(), SetFilePath(), SetFilePath(), SetFilePath(), and SetProcessingFlags().

Here is the call graph for this function:

Here is the caller graph for this function:

IsOpen() [2/2]

virtual bool BmnIFileReader::IsOpen ( ) const

nodiscardpure virtualnoexcept

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References IsOpen().

Here is the call graph for this function:

Open() [1/10]

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

pure virtual

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References Open().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Open() [2/10]

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

pure virtual

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References Open().

Here is the call graph for this function:

Open() [3/10]

void BmnIFileReader::Open ( const std::filesystem::path & filePath, const BmnBinaryFileProcessingOptions processingFlags = BmnBinaryFileProcessingOptions::ReadBinary )

virtual

Definition at line 50 of file BmnIFileReader.cxx.

References fFilePath, and Open().

Here is the call graph for this function:

Open() [4/10]

virtual void BmnIFileReader::Open ( const std::filesystem::path & filePath, const BmnBinaryFileProcessingOptions processingFlags = BmnBinaryFileProcessingOptions::ReadBinary )

virtual

References Open().

Here is the call graph for this function:

Open() [5/10]

void BmnIFileReader::Open ( const std::string & fileName, const BmnBinaryFileProcessingOptions processingFlags = BmnBinaryFileProcessingOptions::ReadBinary )

virtual

Definition at line 32 of file BmnIFileReader.cxx.

References fFilePath, and Open().

Here is the call graph for this function:

Open() [6/10]

virtual void BmnIFileReader::Open ( const std::string & fileName, const BmnBinaryFileProcessingOptions processingFlags = BmnBinaryFileProcessingOptions::ReadBinary )

virtual

References Open().

Here is the call graph for this function:

Open() [7/10]

void BmnIFileReader::Open ( std::filesystem::path && filePath, const BmnBinaryFileProcessingOptions processingFlags = BmnBinaryFileProcessingOptions::ReadBinary )

virtual

Definition at line 59 of file BmnIFileReader.cxx.

References fFilePath, and Open().

Here is the call graph for this function:

Open() [8/10]

virtual void BmnIFileReader::Open ( std::filesystem::path && filePath, const BmnBinaryFileProcessingOptions processingFlags = BmnBinaryFileProcessingOptions::ReadBinary )

virtual

References Open().

Here is the call graph for this function:

Open() [9/10]

void BmnIFileReader::Open ( std::string && fileName, const BmnBinaryFileProcessingOptions processingFlags = BmnBinaryFileProcessingOptions::ReadBinary )

virtual

Definition at line 41 of file BmnIFileReader.cxx.

References fFilePath, and Open().

Here is the call graph for this function:

Open() [10/10]

virtual void BmnIFileReader::Open ( std::string && fileName, const BmnBinaryFileProcessingOptions processingFlags = BmnBinaryFileProcessingOptions::ReadBinary )

virtual

References Open().

Here is the call graph for this function:

operator=() [1/4]

BmnIFileReader & BmnIFileReader::operator= ( BmnIFileReader && )

deletenoexcept

References BmnIFileReader().

Here is the call graph for this function:

operator=() [2/4]

BmnIFileReader & BmnIFileReader::operator= ( BmnIFileReader && )

deletenoexcept

References BmnIFileReader().

Here is the call graph for this function:

operator=() [3/4]

BmnIFileReader & BmnIFileReader::operator= ( const BmnIFileReader & )

delete

References BmnIFileReader().

Here is the call graph for this function:

operator=() [4/4]

BmnIFileReader & BmnIFileReader::operator= ( const BmnIFileReader & )

delete

References BmnIFileReader().

Here is the call graph for this function:

PerformStandardChecksBeforeOpening() [1/2]

bool BmnIFileReader::PerformStandardChecksBeforeOpening ( const BmnBinaryFileProcessingOptions processingFlags )

nodiscardprotected

Definition at line 72 of file BmnIFileReader.cxx.

References cg_compressionIntensityFlags, cg_compressionMemoryFlags, cg_writeFileFlags, Close(), fFilePath, fProcessingFlags, HasAnyFlags(), None, and ReadBinary.

Referenced by IsOpen(), BmnFileReaderRaw::Open(), BmnFileReaderXzLzma::Open(), BmnFileReaderZLib::Open(), BmnFileReaderZLibNG::Open(), BmnFileReaderZStd::Open(), and PerformStandardChecksBeforeOpening().

Here is the call graph for this function:

Here is the caller graph for this function:

PerformStandardChecksBeforeOpening() [2/2]

bool BmnIFileReader::PerformStandardChecksBeforeOpening ( const BmnBinaryFileProcessingOptions processingFlags )

nodiscardprotected

References BmnIFileReader(), fFilePath, fFileType, fProcessingFlags, IsOpen(), PerformStandardChecksBeforeOpening(), and SetFilePath().

Here is the call graph for this function:

Read() [1/2]

virtual int64_t BmnIFileReader::Read ( void * dataPointer, int64_t numberOfBytesToRead )

pure virtual

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References Read().

Referenced by Read().

Here is the call graph for this function:

Here is the caller graph for this function:

Read() [2/2]

virtual int64_t BmnIFileReader::Read ( void * dataPointer, int64_t numberOfBytesToRead )

pure virtual

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References Read().

Here is the call graph for this function:

RemoveProcessingFlags() [1/2]

void BmnIFileReader::RemoveProcessingFlags ( const BmnBinaryFileProcessingOptions badFlags )

inlinenoexcept

Definition at line 283 of file BmnIFileReader.h.

References fProcessingFlags, and IsOpen().

Referenced by IsOpen(), and RemoveProcessingFlags().

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveProcessingFlags() [2/2]

void BmnIFileReader::RemoveProcessingFlags ( const BmnBinaryFileProcessingOptions )

inlinenoexcept

References RemoveProcessingFlags().

Here is the call graph for this function:

Seek() [1/2]

virtual void BmnIFileReader::Seek ( int64_t aNewReadingPosition )

pure virtual

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References Seek().

Referenced by Seek().

Here is the call graph for this function:

Here is the caller graph for this function:

Seek() [2/2]

virtual void BmnIFileReader::Seek ( int64_t aNewReadingPosition )

pure virtual

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References Seek().

Here is the call graph for this function:

SetFilePath() [1/8]

void BmnIFileReader::SetFilePath ( const std::filesystem::path & filePath )

inline

Definition at line 230 of file BmnIFileReader.h.

References fFilePath, and IsOpen().

Here is the call graph for this function:

SetFilePath() [2/8]

void BmnIFileReader::SetFilePath ( const std::filesystem::path & filePath )

inline

References SetFilePath().

Here is the call graph for this function:

SetFilePath() [3/8]

void BmnIFileReader::SetFilePath ( const std::string & fileName )

inline

Definition at line 212 of file BmnIFileReader.h.

References BmnIFileReader(), fFilePath, IsOpen(), and SetFilePath().

Referenced by IsOpen(), PerformStandardChecksBeforeOpening(), SetFilePath(), SetFilePath(), SetFilePath(), and SetFilePath().

Here is the call graph for this function:

Here is the caller graph for this function:

SetFilePath() [4/8]

void BmnIFileReader::SetFilePath ( const std::string & fileName )

inline

References SetFilePath().

Here is the call graph for this function:

SetFilePath() [5/8]

void BmnIFileReader::SetFilePath ( std::filesystem::path && filePath )

inlinenoexcept

Definition at line 239 of file BmnIFileReader.h.

References fFilePath, and IsOpen().

Here is the call graph for this function:

SetFilePath() [6/8]

void BmnIFileReader::SetFilePath ( std::filesystem::path && filePath )

inlinenoexcept

References SetFilePath().

Here is the call graph for this function:

SetFilePath() [7/8]

void BmnIFileReader::SetFilePath ( std::string && fileName )

inlinenoexcept

Definition at line 221 of file BmnIFileReader.h.

References fFilePath, and IsOpen().

Here is the call graph for this function:

SetFilePath() [8/8]

void BmnIFileReader::SetFilePath ( std::string && fileName )

inlinenoexcept

References SetFilePath().

Here is the call graph for this function:

SetProcessingFlags() [1/2]

void BmnIFileReader::SetProcessingFlags ( const BmnBinaryFileProcessingOptions newFlags )

inlinenoexcept

Definition at line 265 of file BmnIFileReader.h.

References fProcessingFlags, and IsOpen().

Referenced by IsOpen(), and SetProcessingFlags().

Here is the call graph for this function:

Here is the caller graph for this function:

SetProcessingFlags() [2/2]

void BmnIFileReader::SetProcessingFlags ( const BmnBinaryFileProcessingOptions )

inlinenoexcept

References SetProcessingFlags().

Here is the call graph for this function:

Tell() [1/2]

virtual int64_t BmnIFileReader::Tell ( ) const

nodiscardpure virtualnoexcept

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References Tell().

Referenced by Tell().

Here is the call graph for this function:

Here is the caller graph for this function:

Tell() [2/2]

virtual int64_t BmnIFileReader::Tell ( ) const

nodiscardpure virtualnoexcept

Implemented in BmnFileReaderRaw, BmnFileReaderRaw, BmnFileReaderXzLzma, BmnFileReaderXzLzma, BmnFileReaderZLib, BmnFileReaderZLib, BmnFileReaderZLibNG, BmnFileReaderZLibNG, BmnFileReaderZStd, and BmnFileReaderZStd.

References Tell().

Here is the call graph for this function:

Member Data Documentation

fFilePath

std::filesystem::path BmnIFileReader::fFilePath

protected

Definition at line 199 of file BmnIFileReader.h.

Referenced by BmnIFileReader(), BmnIFileReader(), BmnIFileReader(), BmnIFileReader(), GetFilePath(), GetFilePath(), GetInputFileSize(), BmnFileReaderRaw::Open(), BmnFileReaderXzLzma::Open(), BmnFileReaderZLib::Open(), BmnFileReaderZLibNG::Open(), BmnFileReaderZStd::Open(), Open(), Open(), Open(), Open(), PerformStandardChecksBeforeOpening(), SetFilePath(), SetFilePath(), SetFilePath(), and SetFilePath().

fFileType

BmnFileType BmnIFileReader::fFileType

protected

Definition at line 204 of file BmnIFileReader.h.

Referenced by BmnIFileReader(), BmnIFileReader(), BmnIFileReader(), BmnIFileReader(), GetFileType(), and PerformStandardChecksBeforeOpening().

fProcessingFlags

BmnBinaryFileProcessingOptions BmnIFileReader::fProcessingFlags

protected

Definition at line 201 of file BmnIFileReader.h.

Referenced by BmnIFileReader(), BmnIFileReader(), BmnIFileReader(), BmnIFileReader(), AddProcessingFlags(), GetProcessingFlags(), PerformStandardChecksBeforeOpening(), RemoveProcessingFlags(), and SetProcessingFlags().

---

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

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