VTK
9.0.1
|
Abstract interface for data compression classes. More...
#include <vtkDataCompressor.h>
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... | |
vtkDataCompressor * | NewInstance () 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... | |
vtkUnsignedCharArray * | Compress (unsigned char const *uncompressedData, size_t uncompressedSize) |
Compress the given data. More... | |
vtkUnsignedCharArray * | Uncompress (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 |
![]() | |
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) |
vtkCommand * | GetCommand (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) |
![]() | |
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 vtkDataCompressor * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkObject * | New () |
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 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 vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () 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 |
![]() | |
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 () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Additional Inherited Members | |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
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.
@pat Thanks: Homogeneous CompressionLevel behavior contributed by Quincy Wofford (qwoff) and John Patchett ( ord@ lanl. govpatch) ett@ lanl. gov
Definition at line 45 of file vtkDataCompressor.h.
Definition at line 48 of file vtkDataCompressor.h.
|
protected |
|
overrideprotected |
|
static |
|
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.
|
static |
|
protectedvirtual |
Reimplemented in vtkLZMADataCompressor, vtkLZ4DataCompressor, and vtkZLibDataCompressor.
vtkDataCompressor* vtkDataCompressor::NewInstance | ( | ) | const |
|
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.
|
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.
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.
|
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.
|
pure virtual |
Implemented in vtkLZMADataCompressor, vtkZLibDataCompressor, and vtkLZ4DataCompressor.
|
protectedpure virtual |
Implemented in vtkLZMADataCompressor, vtkLZ4DataCompressor, and vtkZLibDataCompressor.
|
protectedpure virtual |
Implemented in vtkLZMADataCompressor, vtkLZ4DataCompressor, and vtkZLibDataCompressor.