BmnRoot 26.10.0-18-g4e3414f9
Software framework of the BM@N experiment
Loading...
Searching...
No Matches
BmnIArchiveLibRead Struct Referenceabstract

#include <BmnIArchiveLibRead.h>

Inheritance diagram for BmnIArchiveLibRead:

Public Member Functions

 BmnIArchiveLibRead ()=default
virtual ~BmnIArchiveLibRead ()=default
virtual BmnFileStreamResults Uncompress (const void *source, const size_t sourceTotalSize, size_t &numberOfReadBytes, void *output, const size_t outputTotalSize, size_t &numberOfSetOutputBytes)=0
virtual std::string GetLastUncompressErrorDescription () const noexcept=0
virtual bool JumpsAllowed () const noexcept=0
virtual void JumpTo (size_t value)=0
virtual size_t GetNumberOfDecompressedBytes () const noexcept=0
virtual bool HasReachedTheEndOfStream () const noexcept=0
virtual bool IsStreamInGoodState () const noexcept=0
 BmnIArchiveLibRead ()=default
virtual ~BmnIArchiveLibRead ()=default
virtual BmnFileStreamResults Uncompress (const void *source, const size_t sourceTotalSize, size_t &numberOfReadBytes, void *output, const size_t outputTotalSize, size_t &numberOfSetOutputBytes)=0
virtual std::string GetLastUncompressErrorDescription () const noexcept=0
virtual bool JumpsAllowed () const noexcept=0
virtual void JumpTo (size_t value)=0
virtual size_t GetNumberOfDecompressedBytes () const noexcept=0
virtual bool HasReachedTheEndOfStream () const noexcept=0
virtual bool IsStreamInGoodState () const noexcept=0

Detailed Description

Definition at line 14 of file BmnIArchiveLibRead.h.

Constructor & Destructor Documentation

◆ BmnIArchiveLibRead() [1/2]

BmnIArchiveLibRead::BmnIArchiveLibRead ( )
default

◆ ~BmnIArchiveLibRead() [1/2]

virtual BmnIArchiveLibRead::~BmnIArchiveLibRead ( )
virtualdefault

◆ BmnIArchiveLibRead() [2/2]

BmnIArchiveLibRead::BmnIArchiveLibRead ( )
default

◆ ~BmnIArchiveLibRead() [2/2]

virtual BmnIArchiveLibRead::~BmnIArchiveLibRead ( )
virtualdefault

Member Function Documentation

◆ GetLastUncompressErrorDescription() [1/2]

virtual std::string BmnIArchiveLibRead::GetLastUncompressErrorDescription ( ) const
nodiscardpure virtualnoexcept

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

◆ GetLastUncompressErrorDescription() [2/2]

virtual std::string BmnIArchiveLibRead::GetLastUncompressErrorDescription ( ) const
nodiscardpure virtualnoexcept

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

◆ GetNumberOfDecompressedBytes() [1/2]

virtual size_t BmnIArchiveLibRead::GetNumberOfDecompressedBytes ( ) const
nodiscardpure virtualnoexcept

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

References GetNumberOfDecompressedBytes().

Referenced by GetNumberOfDecompressedBytes().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetNumberOfDecompressedBytes() [2/2]

virtual size_t BmnIArchiveLibRead::GetNumberOfDecompressedBytes ( ) const
nodiscardpure virtualnoexcept

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

References GetNumberOfDecompressedBytes().

Here is the call graph for this function:

◆ HasReachedTheEndOfStream() [1/2]

virtual bool BmnIArchiveLibRead::HasReachedTheEndOfStream ( ) const
nodiscardpure virtualnoexcept

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

References HasReachedTheEndOfStream().

Referenced by HasReachedTheEndOfStream().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ HasReachedTheEndOfStream() [2/2]

virtual bool BmnIArchiveLibRead::HasReachedTheEndOfStream ( ) const
nodiscardpure virtualnoexcept

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

References HasReachedTheEndOfStream().

Here is the call graph for this function:

◆ IsStreamInGoodState() [1/2]

virtual bool BmnIArchiveLibRead::IsStreamInGoodState ( ) const
nodiscardpure virtualnoexcept

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

References IsStreamInGoodState().

Referenced by IsStreamInGoodState().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ IsStreamInGoodState() [2/2]

virtual bool BmnIArchiveLibRead::IsStreamInGoodState ( ) const
nodiscardpure virtualnoexcept

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

References IsStreamInGoodState().

Here is the call graph for this function:

◆ JumpsAllowed() [1/2]

virtual bool BmnIArchiveLibRead::JumpsAllowed ( ) const
nodiscardpure virtualnoexcept

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

References JumpsAllowed().

Referenced by JumpsAllowed().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ JumpsAllowed() [2/2]

virtual bool BmnIArchiveLibRead::JumpsAllowed ( ) const
nodiscardpure virtualnoexcept

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

References JumpsAllowed().

Here is the call graph for this function:

◆ JumpTo() [1/2]

virtual void BmnIArchiveLibRead::JumpTo ( size_t value)
pure virtual

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

References JumpTo().

Referenced by JumpTo().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ JumpTo() [2/2]

virtual void BmnIArchiveLibRead::JumpTo ( size_t value)
pure virtual

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

References JumpTo().

Here is the call graph for this function:

◆ Uncompress() [1/2]

virtual BmnFileStreamResults BmnIArchiveLibRead::Uncompress ( const void * source,
const size_t sourceTotalSize,
size_t & numberOfReadBytes,
void * output,
const size_t outputTotalSize,
size_t & numberOfSetOutputBytes )
pure virtual

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

◆ Uncompress() [2/2]

virtual BmnFileStreamResults BmnIArchiveLibRead::Uncompress ( const void * source,
const size_t sourceTotalSize,
size_t & numberOfReadBytes,
void * output,
const size_t outputTotalSize,
size_t & numberOfSetOutputBytes )
pure virtual

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

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