Base class for compression and decompression
More...
virtual void checkInputParams |
( |
byte * |
inBlock, |
|
|
size_t |
size |
|
) |
| |
|
inlinevirtual |
Basic checks of input block parameters
- Parameters
-
[in] | inBlock | Pointer to the input data block |
[in] | size | Size in bytes of the input data block |
virtual void checkOutputParams |
( |
byte * |
outBlock, |
|
|
size_t |
size |
|
) |
| |
|
inlinevirtual |
Basic checks of output block parameters
- Parameters
-
[in] | outBlock | Pointer to output data block |
[in] | size | Size in bytes of the output data block |
size_t getUsedOutputDataBlockSize |
( |
| ) |
|
|
inlinevirtual |
Returns the number of bytes used after a call to the run() method
- Returns
- Number of used bytes
Implements CompressionIface.
bool isOutputDataBlockFull |
( |
| ) |
|
|
inlinevirtual |
Reports whether an output data block is full after a call to the run() method
- Returns
- True if an output data block is full, false otherwise
Implements CompressionIface.
virtual void run |
( |
byte * |
outBlock, |
|
|
size_t |
size, |
|
|
size_t |
offset |
|
) |
| |
|
pure virtual |
Performs compression (or decompression) of a data block
- Parameters
-
[out] | outBlock | Pointer to the data block where compression (or decompression) results are stored. Must be at least size+offset bytes |
[in] | size | Number of bytes available in outBlock |
[in] | offset | Offset in bytes, the starting position for compression (or decompression) in outBlock |
Implements CompressionIface.
Performs compression (or decompression) of a data block
- Parameters
-
[out] | outBlock | DataBlock where compression (or decompression) results are stored |
Implements CompressionIface.
virtual void setInputDataBlock |
( |
byte * |
inBlock, |
|
|
size_t |
size, |
|
|
size_t |
offset |
|
) |
| |
|
pure virtual |
Associates an input data block with a compressor (or decompressor)
- Parameters
-
[in] | inBlock | Pointer to the data block to compress (or decompress). Must be at least size+offset bytes |
[in] | size | Number of bytes to compress (or decompress) in inBlock |
[in] | offset | Offset in bytes, the starting position for compression (or decompression) in inBlock |
Implements CompressionIface.
virtual void setInputDataBlock |
( |
DataBlock & |
inBlock | ) |
|
|
pure virtual |
Associates an input data block with a compressor (or decompressor)
- Parameters
-
[in] | inBlock | DataBlock to compress (or decompress) |
Implements CompressionIface.
The documentation for this class was generated from the following file: