Abstract interface for data compression classes. More...

#include <vtkDataCompressor.h>

Inheritance diagram for vtkDataCompressor:

Collaboration diagram for vtkDataCompressor:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkDataCompressor *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual size_t	GetMaximumCompressionSpace (size_t size)=0


size_t	Compress (unsigned char const uncompressedData, size_t uncompressedSize, unsigned char compressedData, size_t compressionSpace)


size_t	Uncompress (unsigned char const compressedData, size_t compressedSize, unsigned char uncompressedData, size_t uncompressedSize)


vtkUnsignedCharArray *	Compress (unsigned char const *uncompressedData, size_t uncompressedSize)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkDataCompressor *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

virtual size_t	CompressBuffer (unsigned char const uncompressedData, size_t uncompressedSize, unsigned char compressedData, size_t compressionSpace)=0

virtual size_t	UncompressBuffer (unsigned char const compressedData, size_t compressedSize, unsigned char uncompressedData, size_t uncompressedSize)=0

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

vtkUnsignedCharArray *	Uncompress (unsigned char const *compressedData, size_t compressedSize, size_t uncompressedSize)

	vtkDataCompressor ()

	~vtkDataCompressor ()

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Abstract interface for data compression classes.

vtkDataCompressor provides a universal interface for data compression. Subclasses provide one compression method and one decompression method. The public interface to all compressors remains the same, and is defined by this class.

Definition at line 32 of file vtkDataCompressor.h.

Member Typedef Documentation

typedef vtkObject vtkDataCompressor::Superclass

Definition at line 35 of file vtkDataCompressor.h.

Constructor & Destructor Documentation

vtkDataCompressor::vtkDataCompressor ( )

protected

Uncompress the given data. A vtkUnsignedCharArray containing the compressed data is returned with a reference count of 1. The size of the uncompressed data must be known by the caller. It should be transmitted from the compressor by a means outside of this class.

vtkDataCompressor::~vtkDataCompressor ( )

protected

Uncompress the given data. A vtkUnsignedCharArray containing the compressed data is returned with a reference count of 1. The size of the uncompressed data must be known by the caller. It should be transmitted from the compressor by a means outside of this class.

Member Function Documentation

static int vtkDataCompressor::IsTypeOf ( const char * type )

static

virtual int vtkDataCompressor::IsA ( const char * name )

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkZLibDataCompressor.

static vtkDataCompressor* vtkDataCompressor::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkDataCompressor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkZLibDataCompressor.

vtkDataCompressor* vtkDataCompressor::NewInstance ( ) const

void vtkDataCompressor::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 vtkObject.

Reimplemented in vtkZLibDataCompressor.

virtual size_t vtkDataCompressor::GetMaximumCompressionSpace ( size_t size )

pure 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.

Implemented in vtkZLibDataCompressor.

size_t vtkDataCompressor::Compress	(	unsigned char const *	uncompressedData,
		size_t	uncompressedSize,
		unsigned char *	compressedData,
		size_t	compressionSpace
	)

Compress the given input data buffer into the given output buffer. The size of the output buffer must be at least as large as the value given by GetMaximumCompressionSpace for the given input size.

size_t vtkDataCompressor::Uncompress	(	unsigned char const *	compressedData,
		size_t	compressedSize,
		unsigned char *	uncompressedData,
		size_t	uncompressedSize
	)

Uncompress the given input data into the given output buffer. The size of the uncompressed data must be known by the caller. It should be transmitted from the compressor by a means outside of this class.

vtkUnsignedCharArray* vtkDataCompressor::Compress	(	unsigned char const *	uncompressedData,
		size_t	uncompressedSize
	)

Compress the given data. A vtkUnsignedCharArray containing the compressed data is returned with a reference count of 1.

vtkUnsignedCharArray* vtkDataCompressor::Uncompress	(	unsigned char const *	compressedData,
		size_t	compressedSize,
		size_t	uncompressedSize
	)

Uncompress the given data. A vtkUnsignedCharArray containing the compressed data is returned with a reference count of 1. The size of the uncompressed data must be known by the caller. It should be transmitted from the compressor by a means outside of this class.

virtual size_t vtkDataCompressor::CompressBuffer	(	unsigned char const *	uncompressedData,
		size_t	uncompressedSize,
		unsigned char *	compressedData,
		size_t	compressionSpace
	)

protectedpure virtual

Implemented in vtkZLibDataCompressor.

virtual size_t vtkDataCompressor::UncompressBuffer	(	unsigned char const *	compressedData,
		size_t	compressedSize,
		unsigned char *	uncompressedData,
		size_t	uncompressedSize
	)

protectedpure virtual

Implemented in vtkZLibDataCompressor.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/Core/vtkDataCompressor.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation