libCZI
Reading and Writing CZI documents made easy
libCZI::CompressParametersOnMap Class Reference

#include <libCZI_compress.h>

Inheritance diagram for libCZI::CompressParametersOnMap:
libCZI::ICompressParameters

Public Member Functions

bool TryGetProperty (int key, CompressParameter *parameter) const override
 
- Public Member Functions inherited from libCZI::ICompressParameters
bool TryGetProperty (libCZI::CompressionParameterKey key, CompressParameter *parameter) const
 

Public Attributes

std::map< int, CompressParametermap
 The key-value map containing "compression parameters".
 

Detailed Description

Simplistic implementation of the compression-parameters property bag. Note that for high-performance scenarios it might be a good idea to re-use instances of this, or have a custom implementation without heap-allocation penalty.

Member Function Documentation

◆ TryGetProperty()

bool libCZI::CompressParametersOnMap::TryGetProperty ( int  key,
CompressParameter parameter 
) const
inlineoverridevirtual

Attempts to get the property for the specified key from the property bag.

Parameters
keyThe key.
[in,out]parameterIf non-null and the key is found, then the value is put here.
Returns
True if the key is found in the property bag; false otherwise.

Implements libCZI::ICompressParameters.


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