vtkDataCompressor.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    $RCSfile: vtkDataCompressor.h,v $

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef __vtkDataCompressor_h
#define __vtkDataCompressor_h

#include "vtkObject.h"

class vtkUnsignedCharArray;

class VTK_IO_EXPORT vtkDataCompressor : public vtkObject
{
public:
  vtkTypeRevisionMacro(vtkDataCompressor,vtkObject);
  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);
  

  vtkUnsignedCharArray* Compress(const unsigned char* uncompressedData,
                                 unsigned long uncompressedSize);
  

  vtkUnsignedCharArray* Uncompress(const unsigned char* compressedData,
                                   unsigned long compressedSize,
                                   unsigned long uncompressedSize);
protected:
  vtkDataCompressor();
  ~vtkDataCompressor();
  
  // Actual compression method.  This must be provided by a subclass.
  // Must return the size of the compressed data, or zero on error.
  virtual unsigned long CompressBuffer(const unsigned char* uncompressedData,
                                       unsigned long uncompressedSize,
                                       unsigned char* compressedData,
                                       unsigned long compressionSpace)=0;  
  // Actual decompression method.  This must be provided by a subclass.
  // Must return the size of the uncompressed data, or zero on error.
  virtual unsigned long UncompressBuffer(const unsigned char* compressedData,
                                         unsigned long compressedSize,
                                         unsigned char* uncompressedData,
                                         unsigned long uncompressedSize)=0;
private:
  vtkDataCompressor(const vtkDataCompressor&);  // Not implemented.
  void operator=(const vtkDataCompressor&);  // Not implemented.
};

#endif

---