Helper class for compressor arguments managed inside of a module. More...

#include <mlImageFormatCompressionParams.h>

Public Member Functions
	MLImageFormatCompressionParams (Module &baseOp)
	Constructor; only available with a valid Module reference.
void	updateHintFieldsFromCompressor (DataCompressor *compressor)
void	updateHintVisibility (const DataCompressor *compressor)
void	updateCompressorArgsFromHintFields (const DataCompressor *compressor)
void	handleCompressionFieldChanges (Field *field)
void	updateCompressionFieldsToLoaderState (const MLImageFormat &loader)
void	resetCompressionParams ()
	Reset _compressionFld, _tagListFld, and all _tagListFld.
Access functions; see comments or related members for more information.
EnumField &	getCompressorNameFld () const
NotifyField &	getUpdateHintControlsFld () const
const std::vector< std::string > &	getCompressorNames () const
MLImageFormatTagList &	getCompressorArgs ()
StringField const	getHintNameFlds () const
DoubleField const	getDblHintValFlds () const
IntField const	getIntHintValFlds () const
StringField const	getStrHintValFlds () const
BoolField const	getBoolHintValFlds () const
BoolField const	getIntHintVisibleFlds () const
BoolField const	getStrHintVisibleFlds () const
BoolField const	getDblHintVisibleFlds () const
BoolField const	getBoolHintVisibleFlds () const

Protected Attributes
Module &	_baseOp
	Reference to the related Module.
std::vector< std::string >	_compressorNames
	List of available compressor names stored when creating the module.
MLImageFormatTagList	_compressorArgs
	List of tags used as parameters for compressors.
EnumField *	_compressorNameFld
	Compression scheme used for stored image data. Default is the first entry.
NotifyField *	_updateHintControlsFld
Optional compression arguments used dependent on the hint settings of the compressor.
StringField *	_hintNameFld [DataCompressor::MaxHints]
	Name of the parameter.
DoubleField *	_dblHintValFld [DataCompressor::MaxHints]
	Value of double parameter.
IntField *	_intHintValFld [DataCompressor::MaxHints]
	Value of integer parameter.
StringField *	_strHintValFld [DataCompressor::MaxHints]
	Value of string parameter.
BoolField *	_boolHintValFld [DataCompressor::MaxHints]
	Value of bool parameter.
BoolField *	_intHintVisibleFld [DataCompressor::MaxHints]
	Controls visibility of integer parameter.
BoolField *	_strHintVisibleFld [DataCompressor::MaxHints]
	Controls visibility of string parameter.
BoolField *	_dblHintVisibleFld [DataCompressor::MaxHints]
	Controls visibility of double parameter.
BoolField *	_boolHintVisibleFld [DataCompressor::MaxHints]
	Controls visibility of boolean parameter.

Detailed Description

Helper class for compressor arguments managed inside of a module.

Definition at line 37 of file mlImageFormatCompressionParams.h.

Constructor & Destructor Documentation

◆ MLImageFormatCompressionParams()

ml::MLImageFormatCompressionParams::MLImageFormatCompressionParams ( Module & baseOp )

Constructor; only available with a valid Module reference.

Member Function Documentation

◆ getBoolHintValFlds()

BoolField *const * ml::MLImageFormatCompressionParams::getBoolHintValFlds ( ) const

inline

Definition at line 54 of file mlImageFormatCompressionParams.h.

References _boolHintValFld.

◆ getBoolHintVisibleFlds()

BoolField *const * ml::MLImageFormatCompressionParams::getBoolHintVisibleFlds ( ) const

inline

Definition at line 58 of file mlImageFormatCompressionParams.h.

References _boolHintVisibleFld.

◆ getCompressorArgs()

MLImageFormatTagList & ml::MLImageFormatCompressionParams::getCompressorArgs ( )

inline

Definition at line 49 of file mlImageFormatCompressionParams.h.

References _compressorArgs.

◆ getCompressorNameFld()

EnumField & ml::MLImageFormatCompressionParams::getCompressorNameFld ( ) const

inline

Definition at line 46 of file mlImageFormatCompressionParams.h.

References _compressorNameFld.

◆ getCompressorNames()

const std::vector< std::string > & ml::MLImageFormatCompressionParams::getCompressorNames ( ) const

inline

Definition at line 48 of file mlImageFormatCompressionParams.h.

References _compressorNames.

◆ getDblHintValFlds()

DoubleField *const * ml::MLImageFormatCompressionParams::getDblHintValFlds ( ) const

inline

Definition at line 51 of file mlImageFormatCompressionParams.h.

References _dblHintValFld.

◆ getDblHintVisibleFlds()

BoolField *const * ml::MLImageFormatCompressionParams::getDblHintVisibleFlds ( ) const

inline

Definition at line 57 of file mlImageFormatCompressionParams.h.

References _dblHintVisibleFld.

◆ getHintNameFlds()

StringField *const * ml::MLImageFormatCompressionParams::getHintNameFlds ( ) const

inline

Definition at line 50 of file mlImageFormatCompressionParams.h.

References _hintNameFld.

◆ getIntHintValFlds()

IntField *const * ml::MLImageFormatCompressionParams::getIntHintValFlds ( ) const

inline

Definition at line 52 of file mlImageFormatCompressionParams.h.

References _intHintValFld.

◆ getIntHintVisibleFlds()

BoolField *const * ml::MLImageFormatCompressionParams::getIntHintVisibleFlds ( ) const

inline

Definition at line 55 of file mlImageFormatCompressionParams.h.

References _intHintVisibleFld.

◆ getStrHintValFlds()

StringField *const * ml::MLImageFormatCompressionParams::getStrHintValFlds ( ) const

inline

Definition at line 53 of file mlImageFormatCompressionParams.h.

References _strHintValFld.

◆ getStrHintVisibleFlds()

BoolField *const * ml::MLImageFormatCompressionParams::getStrHintVisibleFlds ( ) const

inline

Definition at line 56 of file mlImageFormatCompressionParams.h.

References _strHintVisibleFld.

◆ getUpdateHintControlsFld()

NotifyField & ml::MLImageFormatCompressionParams::getUpdateHintControlsFld ( ) const

inline

Definition at line 47 of file mlImageFormatCompressionParams.h.

References _updateHintControlsFld.

◆ handleCompressionFieldChanges()

void ml::MLImageFormatCompressionParams::handleCompressionFieldChanges ( Field * field )

Updates the compressor and the fields showing compression parameters. If field is _compressorNameFld, then parameters are read from the a temporarily created compressor and passed to the fields; otherwise, the field settings are passed to the compressor. Use NULL as argument to update settings from a newly loaded field values.

◆ resetCompressionParams()

void ml::MLImageFormatCompressionParams::resetCompressionParams ( )

Reset _compressionFld, _tagListFld, and all _tagListFld.

◆ updateCompressionFieldsToLoaderState()

void ml::MLImageFormatCompressionParams::updateCompressionFieldsToLoaderState ( const MLImageFormat & loader )

Helper function to update compression fields to the compressor settings of the the passed loader. It is recommended to use a loader of an opened file to get current values.

◆ updateCompressorArgsFromHintFields()

void ml::MLImageFormatCompressionParams::updateCompressorArgsFromHintFields ( const DataCompressor * compressor )

Clears the compressor arguments and updates them with new values from those hint fields that are valid according to the given compressor configuration. If compressor is NULL, then compressor arguments are reset/cleared.

◆ updateHintFieldsFromCompressor()

void ml::MLImageFormatCompressionParams::updateHintFieldsFromCompressor ( DataCompressor * compressor )

Sets up all hint fields and their visibility according to the compressor configuration. If compressor is NULL, then all hint fields are reset to their default state.

◆ updateHintVisibility()

void ml::MLImageFormatCompressionParams::updateHintVisibility ( const DataCompressor * compressor )

Sets visibility and hint name fields according to the given compressor configuration. If compressor is NULL, then all hint visibilities are disabled and the names are set empty.