Lunchbox  1.13.0
Multi-threaded C++ toolbox library for all application developers creating high-performance multi-threaded programs.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
lunchbox::Decompressor Class Reference

A C++ class to handle one decompressor plugin instance. More...

#include <decompressor.h>

+ Inheritance diagram for lunchbox::Decompressor:
+ Collaboration diagram for lunchbox::Decompressor:

Public Member Functions

 Decompressor ()
 Construct a new, invalid decompressor instance. More...
 
 Decompressor (PluginRegistry &from, const uint32_t name)
 Construct a new decompressor instance. More...
 
virtual ~Decompressor ()
 Destruct this decompressor. More...
 
bool isGood () const
 
 operator bool_t () const
 
bool operator! () const
 
bool uses (const uint32_t name) const
 
const EqCompressorInfogetInfo () const
 
bool setup (PluginRegistry &from, const uint32_t name)
 Set up a new, named decompressor instance. More...
 
void clear ()
 Reset to EQ_COMPRESSOR_NONE. More...
 
void decompress (const void *const *in, const uint64_t *const inSizes, const unsigned numInputs, void *const out, uint64_t outDim[2])
 Decompress one-dimensional data. More...
 
bool decompress (const CompressorResult &input, void *const out, uint64_t pvpOut[4], const uint64_t flags)
 Decompress two-dimensional data. More...
 
void decompress (const void *const *in, const uint64_t *const inSizes, const unsigned numInputs, void *const out, uint64_t pvpOut[4], const uint64_t flags) LB_DEPRECATED
 

Detailed Description

A C++ class to handle one decompressor plugin instance.

Example:

Definition at line 36 of file decompressor.h.

Constructor & Destructor Documentation

lunchbox::Decompressor::Decompressor ( )

Construct a new, invalid decompressor instance.

Version
1.7.1
lunchbox::Decompressor::Decompressor ( PluginRegistry from,
const uint32_t  name 
)

Construct a new decompressor instance.

Parameters
fromthe plugin registry.
namethe name of the decompressor.
Version
1.7.1
virtual lunchbox::Decompressor::~Decompressor ( )
virtual

Destruct this decompressor.

Version
1.7.1

Member Function Documentation

void lunchbox::Decompressor::clear ( )

Reset to EQ_COMPRESSOR_NONE.

Version
1.7.1
void lunchbox::Decompressor::decompress ( const void *const *  in,
const uint64_t *const  inSizes,
const unsigned  numInputs,
void *const  out,
uint64_t  outDim[2] 
)

Decompress one-dimensional data.

Parameters
inthe pointer to an array of input data pointers
inSizesthe array of input data sizes in bytes
numInputsthe number of input data elements
outthe pointer to a pre-allocated buffer for the uncompressed output result.
outDimthe dimensions of the output data.
Version
1.7.1
bool lunchbox::Decompressor::decompress ( const CompressorResult input,
void *const  out,
uint64_t  pvpOut[4],
const uint64_t  flags 
)

Decompress two-dimensional data.

The output is not modified on error.

Parameters
inputthe compressed data
outthe pointer to a pre-allocated buffer for the uncompressed output result.
pvpOutthe dimensions of the output data.
flagscapability flags for the decompression.
Returns
true on success, false otherwise
Version
1.9.1
const EqCompressorInfo& lunchbox::Decompressor::getInfo ( ) const
Returns
the information about the allocated instance.
Version
1.7.1
bool lunchbox::Decompressor::isGood ( ) const
Returns
true if the instance is usable.
Version
1.7.1

Referenced by operator bool_t(), and operator!().

+ Here is the caller graph for this function:

lunchbox::Decompressor::operator bool_t ( ) const
inline
Returns
true if the instance is usable, false otherwise.
Version
1.9.1

Definition at line 63 of file decompressor.h.

References isGood().

+ Here is the call graph for this function:

bool lunchbox::Decompressor::operator! ( ) const
inline
Returns
true if the instance is not usable.
Version
1.9.1

Definition at line 66 of file decompressor.h.

References isGood().

+ Here is the call graph for this function:

bool lunchbox::Decompressor::setup ( PluginRegistry from,
const uint32_t  name 
)

Set up a new, named decompressor instance.

Parameters
fromthe plugin registry.
namethe name of the decompressor.
Returns
true on success, false otherwise.
Version
1.7.1
bool lunchbox::Decompressor::uses ( const uint32_t  name) const
Returns
true if the instance is usable for the given name.
Version
1.7.1

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