Class ICompressParameters

Class ICompressParameters#

Inheritance Relationships#

Derived Type#

Class Documentation#

class ICompressParameters#

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.

Subclassed by libCZI::CompressParametersOnMap

Public Functions

virtual bool TryGetProperty(int key, CompressParameter *parameter) const = 0#

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

Parameters:

  • key – The key.

  • parameter – [inout] 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.

virtual ~ICompressParameters() = default#
inline bool TryGetProperty(libCZI::CompressionParameterKey key, CompressParameter *parameter) const#

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.

  • parameter – [inout] 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.

Contents