HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
UT_BloscCompressionFilter Class Reference

#include <UT_BloscCompressionFilter.h>

+ Inheritance diagram for UT_BloscCompressionFilter:

Public Types

typedef char char_type
 

Public Member Functions

 UT_BloscCompressionFilter (size_t typeSize, size_t blockSize, bool doShuffle=true, int compressionLevel=9)
 
virtual ~UT_BloscCompressionFilter ()
 
UT_CompressedBlockIndex getIndex ()
 Retrieves the list of locations in the file where the blocks are. More...
 
exint getCurrentLocation ()
 Retrieves the current location in the file. More...
 
std::streamsize doCompression ()
 
template<typename Sink >
std::streamsize write (Sink &dest, const char *sourceBuffer, std::streamsize sourceBufferSize)
 
template<typename Sink >
void close (Sink &dest)
 

Detailed Description

The blosc compression filter is an implementation of boost multicharacter output filter It can be used in boost output streams to compress data using blosc on write.

Definition at line 27 of file UT_BloscCompressionFilter.h.

Member Typedef Documentation

Definition at line 53 of file UT_BloscCompressionFilter.h.

Constructor & Destructor Documentation

UT_BloscCompressionFilter::UT_BloscCompressionFilter ( size_t  typeSize,
size_t  blockSize,
bool  doShuffle = true,
int  compressionLevel = 9 
)
inlineexplicit

Blosc Compression Filter Construct and push onto boost stream.

Parameters
[in]typeSizeThe byte size of the atomic type in the binary stream
[in]blockSizeThe block size to force blosc to use.
[in]doShuffleTrue to run the shuffler. Default = true
[in]compressionLevelThe compression level to give blosc possible values are [1-9] with 9 being the most compression.

Definition at line 85 of file UT_BloscCompressionFilter.h.

UT_BloscCompressionFilter::~UT_BloscCompressionFilter ( )
inlinevirtual

Definition at line 93 of file UT_BloscCompressionFilter.h.

Member Function Documentation

template<typename Sink >
void UT_BloscCompressionFilter::close ( Sink &  dest)
inline

Definition at line 180 of file UT_BloscCompressionFilter.h.

std::streamsize UT_BloscCompressionFilter::doCompression ( )
inline

Compresses all data available in the input buffer. Writing it to the output buffer. Returns the compressed size if the data put in the output buffer.

Definition at line 109 of file UT_BloscCompressionFilter.h.

exint UT_BloscCompressionFilter::getCurrentLocation ( )
inline

Retrieves the current location in the file.

Definition at line 104 of file UT_BloscCompressionFilter.h.

UT_CompressedBlockIndex UT_BloscCompressionFilter::getIndex ( )
inline

Retrieves the list of locations in the file where the blocks are.

Definition at line 99 of file UT_BloscCompressionFilter.h.

template<typename Sink >
std::streamsize UT_BloscCompressionFilter::write ( Sink &  dest,
const char *  sourceBuffer,
std::streamsize  sourceBufferSize 
)
inline

Definition at line 129 of file UT_BloscCompressionFilter.h.


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