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

Interface for writing Seekable Compressed Format (SCF) files. More...

#include <UT_SCFWriter.h>

Public Member Functions

 UT_SCFWriter (bool doShuffleing=true, exint typeSize=4, exint blockSize=65536, UT_CompressionType type=UT_COMPRESSION_TYPE_BLOSC, int compressionlevel=UT_SCF_BLOSC_COMPRESSION_LEVEL)
 
 ~UT_SCFWriter ()
 
void setCompressionType (UT_CompressionType type)
 
void setBlockSize (exint blockSize)
 
bios::filtering_ostream * getOutputStream (const char *filename)
 
bios::filtering_ostream * getOutputStream (std::ostream *outStream)
 
void close ()
 Closes the file. More...
 

Detailed Description

Interface for writing Seekable Compressed Format (SCF) files.

Definition at line 25 of file UT_SCFWriter.h.

Constructor & Destructor Documentation

UT_SCFWriter::UT_SCFWriter ( bool  doShuffleing = true,
exint  typeSize = 4,
exint  blockSize = 65536,
UT_CompressionType  type = UT_COMPRESSION_TYPE_BLOSC,
int  compressionlevel = UT_SCF_BLOSC_COMPRESSION_LEVEL 
)
UT_SCFWriter::~UT_SCFWriter ( )

Member Function Documentation

void UT_SCFWriter::close ( )

Closes the file.

bios::filtering_ostream* UT_SCFWriter::getOutputStream ( const char *  filename)

Retrieves an output stream to write uncompressed data into the file. This is equivalent to open().

Parameters
filenameFilename to write to.
bios::filtering_ostream* UT_SCFWriter::getOutputStream ( std::ostream *  outStream)

Retrieves an output stream to write uncompressed data into the file. This is equivalent to open().

Parameters
outStreamStream to write to.
void UT_SCFWriter::setBlockSize ( exint  blockSize)

Set's the size of each block in the SCF. The default block size is: <TODO: Fill this in with default block size>

void UT_SCFWriter::setCompressionType ( UT_CompressionType  type)

Sets the compression type for the compressed blocks section of the SCF.


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