VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkZLibDataCompressor Class Reference

Data compression using zlib. More...

#include <vtkZLibDataCompressor.h>

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

Public Types

typedef vtkDataCompressor Superclass
 
- Public Types inherited from vtkDataCompressor
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...
 
vtkZLibDataCompressorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
size_t GetMaximumCompressionSpace (size_t size) override
 Get the maximum space that may be needed to store data of the given uncompressed size after compression. More...
 
int GetCompressionLevel () override
 Get/Set the compression level. More...
 
void SetCompressionLevel (int compressionLevel) override
 Get/Set the compression level. More...
 
- Public Member Functions inherited from vtkDataCompressor
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...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given 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 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkZLibDataCompressorSafeDownCast (vtkObjectBase *o)
 
static vtkZLibDataCompressorNew ()
 
- Static Public Member Functions inherited from vtkDataCompressor
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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkZLibDataCompressor ()
 
 ~vtkZLibDataCompressor () override
 
size_t CompressBuffer (unsigned char const *uncompressedData, size_t uncompressedSize, unsigned char *compressedData, size_t compressionSpace) override
 
size_t UncompressBuffer (unsigned char const *compressedData, size_t compressedSize, unsigned char *uncompressedData, size_t uncompressedSize) override
 
- Protected Member Functions inherited from vtkDataCompressor
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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int CompressionLevel
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

Data compression using zlib.

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

Definition at line 29 of file vtkZLibDataCompressor.h.

Member Typedef Documentation

◆ Superclass

Definition at line 32 of file vtkZLibDataCompressor.h.

Constructor & Destructor Documentation

◆ vtkZLibDataCompressor()

vtkZLibDataCompressor::vtkZLibDataCompressor ( )
protected

◆ ~vtkZLibDataCompressor()

vtkZLibDataCompressor::~vtkZLibDataCompressor ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkZLibDataCompressor::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 vtkDataCompressor.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkZLibDataCompressor::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataCompressor.

◆ NewInstance()

vtkZLibDataCompressor * vtkZLibDataCompressor::NewInstance ( ) const

◆ PrintSelf()

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

◆ New()

static vtkZLibDataCompressor * vtkZLibDataCompressor::New ( )
static

◆ GetMaximumCompressionSpace()

size_t vtkZLibDataCompressor::GetMaximumCompressionSpace ( size_t  size)
overridevirtual

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.

◆ GetCompressionLevel()

int vtkZLibDataCompressor::GetCompressionLevel ( )
overridevirtual

Get/Set the compression level.

Implements vtkDataCompressor.

◆ SetCompressionLevel()

void vtkZLibDataCompressor::SetCompressionLevel ( int  compressionLevel)
overridevirtual

Get/Set the compression level.

Implements vtkDataCompressor.

◆ CompressBuffer()

size_t vtkZLibDataCompressor::CompressBuffer ( unsigned char const *  uncompressedData,
size_t  uncompressedSize,
unsigned char *  compressedData,
size_t  compressionSpace 
)
overrideprotectedvirtual

Implements vtkDataCompressor.

◆ UncompressBuffer()

size_t vtkZLibDataCompressor::UncompressBuffer ( unsigned char const *  compressedData,
size_t  compressedSize,
unsigned char *  uncompressedData,
size_t  uncompressedSize 
)
overrideprotectedvirtual

Implements vtkDataCompressor.

Member Data Documentation

◆ CompressionLevel

int vtkZLibDataCompressor::CompressionLevel
protected

Definition at line 59 of file vtkZLibDataCompressor.h.


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