VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkDataCompressor Class Referenceabstract

Abstract interface for data compression classes. More...

#include <vtkDataCompressor.h>

Inheritance diagram for vtkDataCompressor:
[legend]
Collaboration diagram for vtkDataCompressor:
[legend]

Public Types

typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual unsigned long GetMaximumCompressionSpace (unsigned long size)=0
 
unsigned long Compress (const unsigned char *uncompressedData, unsigned long uncompressedSize, unsigned char *compressedData, unsigned long compressionSpace)
 
unsigned long Uncompress (const unsigned char *compressedData, unsigned long compressedSize, unsigned char *uncompressedData, unsigned long uncompressedSize)
 
vtkUnsignedCharArrayCompress (const unsigned char *uncompressedData, unsigned long uncompressedSize)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char 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)
 
vtkCommandGetCommand (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)
 
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 &os)
 
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 vtkDataCompressorSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

virtual unsigned long CompressBuffer (const unsigned char *uncompressedData, unsigned long uncompressedSize, unsigned char *compressedData, unsigned long compressionSpace)=0
 
virtual unsigned long UncompressBuffer (const unsigned char *compressedData, unsigned long compressedSize, unsigned char *uncompressedData, unsigned long 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 &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 
vtkUnsignedCharArrayUncompress (const unsigned char *compressedData, unsigned long compressedSize, unsigned long uncompressedSize)
 
 vtkDataCompressor ()
 
 ~vtkDataCompressor ()
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int 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 31 of file vtkDataCompressor.h.

Member Typedef Documentation

Definition at line 34 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

virtual const char* vtkDataCompressor::GetClassName ( )
virtual

Reimplemented from vtkObject.

Reimplemented in vtkZLibDataCompressor.

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 ( vtkObject o)
static
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 unsigned long vtkDataCompressor::GetMaximumCompressionSpace ( unsigned long  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.

unsigned long vtkDataCompressor::Compress ( const unsigned char *  uncompressedData,
unsigned long  uncompressedSize,
unsigned char *  compressedData,
unsigned long  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.

unsigned long vtkDataCompressor::Uncompress ( const unsigned char *  compressedData,
unsigned long  compressedSize,
unsigned char *  uncompressedData,
unsigned long  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 ( const unsigned char *  uncompressedData,
unsigned long  uncompressedSize 
)

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

vtkUnsignedCharArray* vtkDataCompressor::Uncompress ( const unsigned char *  compressedData,
unsigned long  compressedSize,
unsigned long  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 unsigned long vtkDataCompressor::CompressBuffer ( const unsigned char *  uncompressedData,
unsigned long  uncompressedSize,
unsigned char *  compressedData,
unsigned long  compressionSpace 
)
protectedpure virtual

Implemented in vtkZLibDataCompressor.

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

Implemented in vtkZLibDataCompressor.


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