ldas-tools-framecpp  2.6.4
Functions
FrameCPP::Compression::GZip Namespace Reference

Routines related to the gzip compression algorith. More...

Functions

void Compress (const CHAR_U *DataIn, INT_8U NBytesIn, size_t Level, boost::shared_array< CHAR_U > &DataOut, INT_8U &NBytesOut)
 Compress the data with GZip. More...
 
void Expand (const CHAR_U *DataIn, INT_8U NBytesIn, boost::shared_array< CHAR_U > &DataOut, INT_8U &NBytesOut)
 Expand the data with GZip. More...
 

Detailed Description

Routines related to the gzip compression algorith.

The routines defined in this namespace are specific to the GZip compression algorithm. Routines are defined for both compression and decompression of data buffers.

Function Documentation

◆ Compress()

void FrameCPP::Compression::GZip::Compress ( const CHAR_U *  DataIn,
INT_8U  NBytesIn,
size_t  Level,
boost::shared_array< CHAR_U > &  DataOut,
INT_8U &  NBytesOut 
)

Compress the data with GZip.

The data must be in an uncompressed state before this is called.

Parameters
[in]DataInPointer to the data to be compressed
[in]NBytesInThe number of bytes to be compressed. Upon return, the size of the compressed buffer is returned.
[in]LevelCompression level.
[out]DataOutPointer to the data to be compressed
[out]NBytesOutThe number of bytes to be compressed. Upon return, the size of the compressed buffer is returned.
Todo:
Correct this documentation

◆ Expand()

void FrameCPP::Compression::GZip::Expand ( const CHAR_U *  DataIn,
INT_8U  NBytesIn,
boost::shared_array< CHAR_U > &  DataOut,
INT_8U &  NBytesOut 
)

Expand the data with GZip.

This will uncompress the data using the appropriate GZip call.

Parameters
[in]DataIn
[in]NBytesIn
[out]DataOut
[in,out]NBytesOutOn input, this must be set to the expected number of bytes for the expanded buffer. On output, this will have the number of bytes in the DataOut buffer.