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 Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkDataCompressorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual size_t GetMaximumCompressionSpace (size_t size)=0
 Get the maximum space that may be needed to store data of the given uncompressed size after compression. More...
 
size_t 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. More...
 
size_t Uncompress (unsigned char const *compressedData, size_t compressedSize, unsigned char *uncompressedData, size_t uncompressedSize)
 Uncompress the given input data into the given output buffer. More...
 
vtkUnsignedCharArrayCompress (unsigned char const *uncompressedData, size_t uncompressedSize)
 Compress the given data. More...
 
vtkUnsignedCharArrayUncompress (unsigned char const *compressedData, size_t compressedSize, size_t uncompressedSize)
 Uncompress the given data. More...
 
virtual void SetCompressionLevel (int compressionLevel)=0
 Compression performance varies greatly with compression level Require level setting from any vtkDataCompressor Different compressors handle performance parameters differently vtkDataCompressors should take a value between 1 and 9 where 1 is fastest compression, and 9 is best compression. More...
 
virtual int GetCompressionLevel ()=0
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataCompressorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataCompressor ()
 
 ~vtkDataCompressor () override
 
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 ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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 &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > 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.

Note:
vtkDataCompressor CompressionLevel maye take on values 1 to 9. With values of 1 giving best compression write performance, and a value of 9 giving best compression ratio. Subclasses of vtkDataCompressor objects should be implemented with this in mind to provide a predictable compressor interface for vtkDataCompressor users.

@pat Thanks: Homogeneous CompressionLevel behavior contributed by Quincy Wofford (qwoff.nosp@m.ord@.nosp@m.lanl..nosp@m.gov) and John Patchett (patch.nosp@m.ett@.nosp@m.lanl..nosp@m.gov)

Definition at line 45 of file vtkDataCompressor.h.

Member Typedef Documentation

◆ Superclass

Definition at line 48 of file vtkDataCompressor.h.

Constructor & Destructor Documentation

◆ vtkDataCompressor()

vtkDataCompressor::vtkDataCompressor ( )
protected

◆ ~vtkDataCompressor()

vtkDataCompressor::~vtkDataCompressor ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

Reimplemented in vtkLZMADataCompressor, vtkLZ4DataCompressor, and vtkZLibDataCompressor.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkDataCompressor::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkDataCompressor* vtkDataCompressor::NewInstance ( ) const

◆ PrintSelf()

void vtkDataCompressor::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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 vtkLZMADataCompressor, vtkLZ4DataCompressor, and vtkZLibDataCompressor.

◆ GetMaximumCompressionSpace()

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 vtkLZMADataCompressor, vtkLZ4DataCompressor, and vtkZLibDataCompressor.

◆ Compress() [1/2]

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.

◆ Uncompress() [1/2]

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.

◆ Compress() [2/2]

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.

◆ Uncompress() [2/2]

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.

◆ SetCompressionLevel()

virtual void vtkDataCompressor::SetCompressionLevel ( int  compressionLevel)
pure virtual

Compression performance varies greatly with compression level Require level setting from any vtkDataCompressor Different compressors handle performance parameters differently vtkDataCompressors should take a value between 1 and 9 where 1 is fastest compression, and 9 is best compression.

Implemented in vtkLZMADataCompressor, vtkZLibDataCompressor, and vtkLZ4DataCompressor.

◆ GetCompressionLevel()

virtual int vtkDataCompressor::GetCompressionLevel ( )
pure virtual

◆ CompressBuffer()

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

◆ UncompressBuffer()

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

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