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

#include <UT_SCCompressionFilter.h>

+ Inheritance diagram for UT_SCCompressionFilter:

Public Types

typedef char char_type

Public Member Functions

 UT_SCCompressionFilter (size_t typesize, size_t blocksize, bool doShuffer=true, int compressionLevel=9)
 SC Compression Filter. More...
virtual ~UT_SCCompressionFilter ()
template<typename Sink >
std::streamsize write (Sink &dest, const char *sourceBuffer, std::streamsize sourceBufferSize)
template<typename Sink >
void close (Sink &dest)

Static Public Attributes

static const size_t theDefaultTypeSize = 4
static const size_t theDefaultBlockSize = (1<<20)

Detailed Description

The SC compression filter is an implementation of boost multicharacter output filter. It can be used with boost output streams to write a .sc file to disk.

Definition at line 23 of file UT_SCCompressionFilter.h.

Member Typedef Documentation

Definition at line 26 of file UT_SCCompressionFilter.h.

Constructor & Destructor Documentation

UT_SCCompressionFilter::UT_SCCompressionFilter ( size_t  typesize,
size_t  blocksize,
bool  doShuffer = true,
int  compressionLevel = 9 

SC Compression Filter.

Definition at line 59 of file UT_SCCompressionFilter.h.

UT_SCCompressionFilter::~UT_SCCompressionFilter ( )

Definition at line 73 of file UT_SCCompressionFilter.h.

Member Function Documentation

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

Definition at line 101 of file UT_SCCompressionFilter.h.

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

Definition at line 81 of file UT_SCCompressionFilter.h.

Member Data Documentation

const size_t UT_SCCompressionFilter::theDefaultBlockSize = (1<<20)

Definition at line 29 of file UT_SCCompressionFilter.h.

const size_t UT_SCCompressionFilter::theDefaultTypeSize = 4

Definition at line 28 of file UT_SCCompressionFilter.h.

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