vtkZLibDataCompressor Class Reference

#include <vtkZLibDataCompressor.h>

Inheritance diagram for vtkZLibDataCompressor:

[legend]Collaboration diagram for vtkZLibDataCompressor:

[legend]List of all members.

Detailed Description

Data compression using zlib.

vtkZLibDataCompressor provides a concrete vtkDataCompressor class using zlib for compressing and uncompressing data.

Created by:

King, Brad

CVS contributions (if > 5%):

King, Brad (91%)
Barre, Sebastien (8%)

CVS logs (CVSweb):

.h (/IO/vtkZLibDataCompressor.h)
.cxx (/IO/vtkZLibDataCompressor.cxx)

Tests:: vtkZLibDataCompressor (Tests)

Definition at line 41 of file vtkZLibDataCompressor.h.

Public Types

typedef vtkDataCompressor Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

unsigned long GetMaximumCompressionSpace (unsigned long size)

virtual void SetCompressionLevel (int)

virtual int GetCompressionLevel ()

Static Public Member Functions

int IsTypeOf (const char *type)

vtkZLibDataCompressor * SafeDownCast (vtkObject *o)

vtkZLibDataCompressor * New ()

Protected Member Functions

vtkZLibDataCompressor ()

~vtkZLibDataCompressor ()

unsigned long CompressBuffer (const unsigned char *uncompressedData, unsigned long uncompressedSize, unsigned char *compressedData, unsigned long compressionSpace)

unsigned long UncompressBuffer (const unsigned char *compressedData, unsigned long compressedSize, unsigned char *uncompressedData, unsigned long uncompressedSize)

Protected Attributes

int CompressionLevel

Member Typedef Documentation

typedef vtkDataCompressor vtkZLibDataCompressor::Superclass

Reimplemented from vtkDataCompressor.
Definition at line 44 of file vtkZLibDataCompressor.h.

Constructor & Destructor Documentation

vtkZLibDataCompressor::vtkZLibDataCompressor ( ) [protected]

vtkZLibDataCompressor::~vtkZLibDataCompressor ( ) [protected]

Member Function Documentation

virtual const char* vtkZLibDataCompressor::GetClassName ( ) [virtual]

Reimplemented from vtkDataCompressor.

int vtkZLibDataCompressor::IsTypeOf ( const char * type ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkDataCompressor.

virtual int vtkZLibDataCompressor::IsA ( const char * type ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkDataCompressor.

vtkZLibDataCompressor* vtkZLibDataCompressor::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkDataCompressor.

void vtkZLibDataCompressor::PrintSelf ( ostream & os,

vtkIndent indent

) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkDataCompressor.

vtkZLibDataCompressor* vtkZLibDataCompressor::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.

unsigned long vtkZLibDataCompressor::GetMaximumCompressionSpace ( unsigned long size ) [virtual]

Get the maximum space that may be needed to store data of the given uncompressed size after compression. This is the minimum size of the output buffer that can be passed to the four-argument Compress method.
Implements vtkDataCompressor.

virtual void vtkZLibDataCompressor::SetCompressionLevel ( int ) [virtual]

Get/Set the compression level.

virtual int vtkZLibDataCompressor::GetCompressionLevel ( ) [virtual]

Get/Set the compression level.

unsigned long vtkZLibDataCompressor::CompressBuffer ( const unsigned char * uncompressedData,

unsigned long uncompressedSize,

unsigned char * compressedData,

unsigned long compressionSpace

) [protected, virtual]

Implements vtkDataCompressor.

unsigned long vtkZLibDataCompressor::UncompressBuffer ( const unsigned char * compressedData,

unsigned long compressedSize,

unsigned char * uncompressedData,

unsigned long uncompressedSize

) [protected, virtual]

Implements vtkDataCompressor.

Member Data Documentation

int vtkZLibDataCompressor::CompressionLevel [protected]

Definition at line 64 of file vtkZLibDataCompressor.h.

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

dox/IO/vtkZLibDataCompressor.h


Public Types
typedef vtkDataCompressor	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
unsigned long	GetMaximumCompressionSpace (unsigned long size)

virtual void	SetCompressionLevel (int)
virtual int	GetCompressionLevel ()
Static Public Member Functions
int	IsTypeOf (const char *type)
vtkZLibDataCompressor *	SafeDownCast (vtkObject *o)
vtkZLibDataCompressor *	New ()
Protected Member Functions
	vtkZLibDataCompressor ()
	~vtkZLibDataCompressor ()
unsigned long	CompressBuffer (const unsigned char uncompressedData, unsigned long uncompressedSize, unsigned char compressedData, unsigned long compressionSpace)
unsigned long	UncompressBuffer (const unsigned char compressedData, unsigned long compressedSize, unsigned char uncompressedData, unsigned long uncompressedSize)
Protected Attributes
int	CompressionLevel