libCZI::ICompressParameters Class Reference

#include <libCZI_compress.h>

Inheritance diagram for libCZI::ICompressParameters:

Public Member Functions
virtual bool	TryGetProperty (int key, CompressParameter *parameter) const =0
bool	TryGetProperty (libCZI::CompressionParameterKey key, CompressParameter *parameter) const

Detailed Description

This interface is used for representing "compression parameters". It is a simple property bag. Possible values for the key are defined in the "CompressionParameter" class.

Member Function Documentation

TryGetProperty() [1/2]

virtual bool libCZI::ICompressParameters::TryGetProperty ( int  key, CompressParameter *  parameter  ) const

pure virtual

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

Parameters

	key	The key.
[in,out]	parameter	If 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.

Implemented in libCZI::CompressParametersOnMap.

TryGetProperty() [2/2]

bool libCZI::ICompressParameters::TryGetProperty ( libCZI::CompressionParameterKey  key, CompressParameter *  parameter  ) const

inline

Attempts to get the property for the specified key from the property bag. This helper is casting the enum to int, facilitating the use with the enum type.

Parameters

	key	The key.
[in,out]	parameter	If 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.

---

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

• libCZI/libCZI_compress.h