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 type_size, size_t block_size, bool do_shuffle=true, int compression_level=9)
	~UT_BloscCompressionFilter ()=default
	UT_BloscCompressionFilter (const UT_BloscCompressionFilter &copy)
UT_BloscCompressionFilter &	operator= (const UT_BloscCompressionFilter &copy)
UT_CompressedBlockIndex	getIndex () const
exint	getCurrentLocation () const
	Retrieves the current location in the file. More...
std::streamsize	doCompression ()
template<typename Sink >
std::streamsize	write (Sink &dest, const char *source_buffer, std::streamsize source_buffer_size)
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 29 of file UT_BloscCompressionFilter.h.

Member Typedef Documentation

typedef char UT_BloscCompressionFilter::char_type

Definition at line 55 of file UT_BloscCompressionFilter.h.

Constructor & Destructor Documentation

UT_BloscCompressionFilter::UT_BloscCompressionFilter ( size_t  type_size, size_t  block_size, bool  do_shuffle = true, int  compression_level = 9  )

inlineexplicit

Blosc Compression Filter Construct and push onto boost stream.

Parameters

[in]	typeSize	The byte size of the atomic type in the binary stream
[in]	blockSize	The block size to force blosc to use.
[in]	doShuffle	True to run the shuffler. Default = true
[in]	compressionLevel	The compression level to give blosc possible values are [1-9] with 9 being the most compression.

Definition at line 95 of file UT_BloscCompressionFilter.h.

UT_BloscCompressionFilter::~UT_BloscCompressionFilter ( )

default

UT_BloscCompressionFilter::UT_BloscCompressionFilter ( const UT_BloscCompressionFilter &  copy )

inline

Definition at line 115 of file UT_BloscCompressionFilter.h.

Member Function Documentation

template<typename Sink >

void UT_BloscCompressionFilter::close ( Sink &  dest )

inline

Definition at line 238 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 161 of file UT_BloscCompressionFilter.h.

exint UT_BloscCompressionFilter::getCurrentLocation ( ) const

inline

Retrieves the current location in the file.

Definition at line 155 of file UT_BloscCompressionFilter.h.

UT_CompressedBlockIndex UT_BloscCompressionFilter::getIndex ( ) const

inline

Retrieves the list of locations in the file where the blocks are WARNING: This method intentionally returns a copy of the index since its liable to change while filtering.

Definition at line 149 of file UT_BloscCompressionFilter.h.

UT_BloscCompressionFilter & UT_BloscCompressionFilter::operator= ( const UT_BloscCompressionFilter &  copy )

inline

Definition at line 130 of file UT_BloscCompressionFilter.h.

template<typename Sink >

std::streamsize UT_BloscCompressionFilter::write ( Sink &  dest, const char *  source_buffer, std::streamsize  source_buffer_size  )

inline

Definition at line 183 of file UT_BloscCompressionFilter.h.

---

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

• UT/UT_BloscCompressionFilter.h