An IO::Compressor for gzip compression from zlib. More...

#include <be_io_gzip.h>

Inherits BiometricEvaluation::IO::Compressor.

Public Member Functions
	GZip ()

Memory::uint8Array	compress (const uint8_t *const uncompressedData, uint64_t uncompressedDataSize) const
	Compress a buffer. More...

Memory::uint8Array	compress (const Memory::uint8Array &uncompressedData) const
	Compress a buffer. More...

void	compress (const uint8_t *const uncompressedData, uint64_t uncompressedDataSize, const std::string &outputFile) const
	Compress a buffer. More...

void	compress (const Memory::uint8Array &uncompressedData, const std::string &outputFile) const
	Compress a buffer. More...

Memory::uint8Array	compress (const std::string &inputFile) const
	Compress a file. More...

void	compress (const std::string &inputFile, const std::string &outputFile) const
	Compress a file. More...

Memory::uint8Array	decompress (const uint8_t *const compressedData, uint64_t compressedDataSize) const
	Decompress a compressed buffer. More...

Memory::uint8Array	decompress (const Memory::uint8Array &compressedData) const
	Decompress a compressed buffer. More...

Memory::uint8Array	decompress (const std::string &input) const
	Decompress a compressed buffer into a file. More...

void	decompress (const std::string &inputFile, const std::string &outputFile) const
	Decompress a file. More...

void	decompress (const uint8_t *const compressedData, const uint64_t compressedDataSize, const std::string &outputFile) const
	Decompress a file. More...

void	decompress (const Memory::uint8Array &compressedData, const std::string &outputFile) const
	Decompress a file. More...

	~GZip ()

	GZip (const GZip &other)=delete
	Copy constructor (disabled). More...

GZip &	operator= (const GZip &other)=delete
	Assignment overload (disabled). More...

Public Member Functions inherited from BiometricEvaluation::IO::Compressor
	Compressor ()
	Create a new Compressor object. More...

virtual Memory::uint8Array	compress (const uint8_t *const uncompressedData, uint64_t uncompressedDataSize) const =0
	Compress a buffer. More...

virtual Memory::uint8Array	compress (const Memory::uint8Array &uncompressedData) const =0
	Compress a buffer. More...

virtual void	compress (const uint8_t *const uncompressedData, uint64_t uncompressedDataSize, const std::string &outputFile) const =0
	Compress a buffer. More...

virtual void	compress (const Memory::uint8Array &uncompressedData, const std::string &outputFile) const =0
	Compress a buffer. More...

virtual Memory::uint8Array	compress (const std::string &inputFile) const =0
	Compress a file. More...

virtual void	compress (const std::string &inputFile, const std::string &outputFile) const =0
	Compress a file. More...

virtual Memory::uint8Array	decompress (const uint8_t *const compressedData, uint64_t compressedDataSize) const =0
	Decompress a compressed buffer. More...

virtual Memory::uint8Array	decompress (const Memory::uint8Array &compressedData) const =0
	Decompress a compressed buffer. More...

virtual Memory::uint8Array	decompress (const std::string &inputFile) const =0
	Decompress a compressed buffer into a file. More...

virtual void	decompress (const Memory::uint8Array &compressedData, const std::string &outputFile) const =0
	Decompress a file. More...

virtual void	decompress (const uint8_t *const compressedData, const uint64_t compressedDataSize, const std::string &outputFile) const =0
	Decompress a file. More...

virtual void	decompress (const std::string &inputFile, const std::string &outputFile) const =0
	Decompress a file. More...

void	setOption (const std::string &optionName, const std::string &optionValue)
	Assign a compressor option. More...

void	setOption (const std::string &optionName, int64_t optionValue)
	Assign a compressor option. More...

std::string	getOption (const std::string &optionName) const
	Obtain a compressor option as an integer. More...

int64_t	getOptionAsInteger (const std::string &optionName) const
	Obtain a compressor option as an integer. More...

void	removeOption (const std::string &optionName)
	Remove a compressor option. More...

virtual	~Compressor ()
	Destructor. More...

	Compressor (const Compressor &other)=delete
	Copy constructor (disabled). More...

Compressor &	operator= (const Compressor &other)=delete
	Assignment overload (disabled). More...

Static Public Attributes
static const std::string	COMPRESSION_LEVEL
	How thorough the compression should be. More...

static const std::string	COMPRESSION_STRATEGY
	Which underlying algorithm to use. More...

static const std::string	COMPRESSION_METHOD
	Which underlying method in the compressor. More...

static const std::string	INPUT_DATA_TYPE
	The type of data being compressed. More...

static const std::string	WINDOW_BITS
	Window size. More...

static const std::string	MEMORY_LEVEL
	How much memory for internal compression state. More...

static const std::string	CHUNK_SIZE
	How many bytes to work at a time. More...

Additional Inherited Members
Public Types inherited from BiometricEvaluation::IO::Compressor
enum class	Kind { GZIP }
	Kinds of Compressors (for factory) More...

Static Public Member Functions inherited from BiometricEvaluation::IO::Compressor
static std::shared_ptr< Compressor >	createCompressor (Compressor::Kind compressorKind=Kind::GZIP)
	Compressor factory. More...

Detailed Description

An IO::Compressor for gzip compression from zlib.

Definition at line 30 of file be_io_gzip.h.

Constructor & Destructor Documentation

◆ GZip() [1/2]

BiometricEvaluation::IO::GZip::GZip ( )

◆ ~GZip()

BiometricEvaluation::IO::GZip::~GZip ( )

◆ GZip() [2/2]

BiometricEvaluation::IO::GZip::GZip ( const GZip & other )

delete

Copy constructor (disabled).

Disabled because Properties member of parent cannot be copied.

Parameters

other GZip to copy.

Member Function Documentation

◆ compress() [1/6]

Memory::uint8Array BiometricEvaluation::IO::GZip::compress	(	const uint8_t *const	uncompressedData,
		uint64_t	uncompressedDataSize
	)		const

virtual

Compress a buffer.

Parameters

uncompressedData	Uncompressed data buffer to compress.
uncompressedDataSize	Size of uncompressedData.

Returns: Compressed buffer.

Exceptions

Error::StrategyError Error in compression unit.

Implements BiometricEvaluation::IO::Compressor.

◆ compress() [2/6]

Memory::uint8Array BiometricEvaluation::IO::GZip::compress ( const Memory::uint8Array & uncompressedData ) const

virtual

Compress a buffer.

Parameters

uncompressedData Uncompressed data buffer to compress.

Returns: Compressed buffer.

Exceptions

Error::StrategyError Error in decompression unit.

Implements BiometricEvaluation::IO::Compressor.

◆ compress() [3/6]

void BiometricEvaluation::IO::GZip::compress	(	const uint8_t *const	uncompressedData,
		uint64_t	uncompressedDataSize,
		const std::string &	outputFile
	)		const

virtual

Compress a buffer.

Parameters

uncompressedData	Uncompressed data buffer to compress.
uncompressedDataSize	Size of uncompressedData.
outputFile	Location to save compressed file.

Exceptions

Error::ObjectExists	Output file already exists.
Error::StrategyError	Error in compression unit.

Implements BiometricEvaluation::IO::Compressor.

◆ compress() [4/6]

void BiometricEvaluation::IO::GZip::compress	(	const Memory::uint8Array &	uncompressedData,
		const std::string &	outputFile
	)		const

virtual

Compress a buffer.

Parameters

uncompressedData	Uncompressed data buffer to compress.
outputFile	Location to save compressed file.

Exceptions

Error::ObjectExists	Output file already exists.
Error::StrategyError	Error in decompression unit.

Implements BiometricEvaluation::IO::Compressor.

◆ compress() [5/6]

Memory::uint8Array BiometricEvaluation::IO::GZip::compress ( const std::string & inputFile ) const

virtual

Compress a file.

Parameters

inputFile Path to file to compress.

Returns: Compressed buffer.

Exceptions

Error::ObjectDoesNotExist	Input file does not exist.
Error::StrategyError	Error in decompression unit.

Implements BiometricEvaluation::IO::Compressor.

◆ compress() [6/6]

void BiometricEvaluation::IO::GZip::compress	(	const std::string &	inputFile,
		const std::string &	outputFile
	)		const

virtual

Compress a file.

Parameters

inputFile	Path to file to compress.
outputFile	Path to location where compressed version will be saved.

Exceptions

Error::ObjectDoesNotExist	Input file does not exist.
Error::ObjectExists	Output file already exists.
Error::StrategyError	Error in decompression unit.

Implements BiometricEvaluation::IO::Compressor.

◆ decompress() [1/6]

Memory::uint8Array BiometricEvaluation::IO::GZip::decompress	(	const uint8_t *const	compressedData,
		uint64_t	compressedDataSize
	)		const

virtual

Decompress a compressed buffer.

Parameters

compressedData	Compressed data buffer to decompress.
compressedDataSize	Size of compressedData.

Returns: Decompressed data.

Exceptions

Error::StrategyError Error in compression unit.

Implements BiometricEvaluation::IO::Compressor.

◆ decompress() [2/6]

Memory::uint8Array BiometricEvaluation::IO::GZip::decompress ( const Memory::uint8Array & compressedData ) const

virtual

Decompress a compressed buffer.

Parameters

compressedData Compressed data buffer to decompress.

Returns: Decompressed data.

Exceptions

Error::StrategyError Error in decompression unit.

Implements BiometricEvaluation::IO::Compressor.

◆ decompress() [3/6]

Memory::uint8Array BiometricEvaluation::IO::GZip::decompress ( const std::string & inputFile ) const

virtual

Decompress a compressed buffer into a file.

Parameters

inputFile Location to save compressed file.

Returns: Decompressed data.

Exceptions

Error::StrategyError	Error in decompression unit.
Error::ObjectDoesNotExists	Output file already exists.

Implements BiometricEvaluation::IO::Compressor.

◆ decompress() [4/6]

void BiometricEvaluation::IO::GZip::decompress	(	const std::string &	inputFile,
		const std::string &	outputFile
	)		const

virtual

Decompress a file.

Parameters

inputFile	Path to file to decompress.
outputFile	Path to location where decompressed version will be saved.

Exceptions

Error::ObjectDoesNotExist	Input file does not exist.
Error::ObjectExists	Output file already exists.
Error::StrategyError	Error in compression unit.

Implements BiometricEvaluation::IO::Compressor.

◆ decompress() [5/6]

void BiometricEvaluation::IO::GZip::decompress	(	const uint8_t *const	compressedData,
		const uint64_t	compressedDataSize,
		const std::string &	outputFile
	)		const

virtual

Decompress a file.

Parameters

compressedData	Compressed data buffer to decompress.
compressedDataSize	Size of compressedData.
outputFile	Path to location where decompressed version will be saved.

Exceptions

Error::ObjectExists	Output file already exists.
Error::StrategyError	Error in compression unit.

Implements BiometricEvaluation::IO::Compressor.

◆ decompress() [6/6]

void BiometricEvaluation::IO::GZip::decompress	(	const Memory::uint8Array &	compressedData,
		const std::string &	outputFile
	)		const

virtual

Decompress a file.

Parameters

compressedData	Compressed data buffer to decompress.
outputFile	Path to location where decompressed version will be saved.

Exceptions

Error::ObjectExists	Output file already exists.
Error::StrategyError	Error in compression unit.

Implements BiometricEvaluation::IO::Compressor.

◆ operator=()

GZip & BiometricEvaluation::IO::GZip::operator= ( const GZip & other )

delete

Assignment overload (disabled).

Disabled because Properties member of parent cannot be assigned.

Parameters

other GZip to assign.

Returns: lhs GZip.

Member Data Documentation

◆ COMPRESSION_LEVEL

const std::string BiometricEvaluation::IO::GZip::COMPRESSION_LEVEL

static

How thorough the compression should be.

Definition at line 37 of file be_io_gzip.h.

◆ COMPRESSION_STRATEGY

const std::string BiometricEvaluation::IO::GZip::COMPRESSION_STRATEGY

static

Which underlying algorithm to use.

Definition at line 39 of file be_io_gzip.h.

◆ COMPRESSION_METHOD

const std::string BiometricEvaluation::IO::GZip::COMPRESSION_METHOD

static

Which underlying method in the compressor.

Definition at line 41 of file be_io_gzip.h.

◆ INPUT_DATA_TYPE

const std::string BiometricEvaluation::IO::GZip::INPUT_DATA_TYPE

static

The type of data being compressed.

Definition at line 43 of file be_io_gzip.h.

◆ WINDOW_BITS

const std::string BiometricEvaluation::IO::GZip::WINDOW_BITS

static

Window size.

Definition at line 45 of file be_io_gzip.h.

◆ MEMORY_LEVEL

const std::string BiometricEvaluation::IO::GZip::MEMORY_LEVEL

static

How much memory for internal compression state.

Definition at line 47 of file be_io_gzip.h.

◆ CHUNK_SIZE

const std::string BiometricEvaluation::IO::GZip::CHUNK_SIZE

static

How many bytes to work at a time.

Definition at line 49 of file be_io_gzip.h.

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

be_io_gzip.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GZip() [1/2]

◆ ~GZip()

◆ GZip() [2/2]

Member Function Documentation

◆ compress() [1/6]

◆ compress() [2/6]

◆ compress() [3/6]

◆ compress() [4/6]

◆ compress() [5/6]

◆ compress() [6/6]

◆ decompress() [1/6]

◆ decompress() [2/6]

◆ decompress() [3/6]

◆ decompress() [4/6]

◆ decompress() [5/6]

◆ decompress() [6/6]

◆ operator=()

Member Data Documentation

◆ COMPRESSION_LEVEL

◆ COMPRESSION_STRATEGY

◆ COMPRESSION_METHOD

◆ INPUT_DATA_TYPE

◆ WINDOW_BITS

◆ MEMORY_LEVEL

◆ CHUNK_SIZE