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	updateHintFieldsOrArgs (bool updateFields, DataCompressor *compressor)
	Update the compressor args or the hint fields from the current compressor settings.
void	handleCompressionFieldChanges (Field *field)
	Update the compressor and the fields showing compression parameters.
void	updateCompressionFieldsToLoaderState (const MLImageFormat &loader)
	Helper function to update compression fields to the compressor settings of the the passed loader.
void	resetCompressionParams ()
	Reset _compressionFld, _tagListFld, and all _tagListFld.
Access functions; see comments or related members for more information.
const EnumField &	getCompressorNameFld () const
const std::vector< std::string > &	getCompressorNames () const
const MLImageFormatTagList &	getCompressorArgs () const
const StringField *const	getHintNameFlds () const
const DoubleField *const	getDblHintValFlds () const
const IntField *const	getIntHintValFlds () const
const StringField *const	getStrHintValFlds () const
const BoolField *const	getBoolHintValFlds () const
const BoolField *const	getIntHintVisibleFlds () const
const BoolField *const	getStrHintVisibleFlds () const
const BoolField *const	getDblHintVisibleFlds () const
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 first entry.
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 44 of file mlImageFormatCompressionParams.h.

Constructor & Destructor Documentation

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

Constructor, only available with a valid Module reference.

Member Function Documentation

const BoolField* const ml::MLImageFormatCompressionParams::getBoolHintValFlds ( ) const [inline]

Definition at line 60 of file mlImageFormatCompressionParams.h.

const BoolField* const ml::MLImageFormatCompressionParams::getBoolHintVisibleFlds ( ) const [inline]

Definition at line 64 of file mlImageFormatCompressionParams.h.

const MLImageFormatTagList& ml::MLImageFormatCompressionParams::getCompressorArgs ( ) const [inline]

Definition at line 55 of file mlImageFormatCompressionParams.h.

const EnumField& ml::MLImageFormatCompressionParams::getCompressorNameFld ( ) const [inline]

Definition at line 53 of file mlImageFormatCompressionParams.h.

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

Definition at line 54 of file mlImageFormatCompressionParams.h.

const DoubleField* const ml::MLImageFormatCompressionParams::getDblHintValFlds ( ) const [inline]

Definition at line 57 of file mlImageFormatCompressionParams.h.

const BoolField* const ml::MLImageFormatCompressionParams::getDblHintVisibleFlds ( ) const [inline]

Definition at line 63 of file mlImageFormatCompressionParams.h.

const StringField* const ml::MLImageFormatCompressionParams::getHintNameFlds ( ) const [inline]

Definition at line 56 of file mlImageFormatCompressionParams.h.

const IntField* const ml::MLImageFormatCompressionParams::getIntHintValFlds ( ) const [inline]

Definition at line 58 of file mlImageFormatCompressionParams.h.

const BoolField* const ml::MLImageFormatCompressionParams::getIntHintVisibleFlds ( ) const [inline]

Definition at line 61 of file mlImageFormatCompressionParams.h.

const StringField* const ml::MLImageFormatCompressionParams::getStrHintValFlds ( ) const [inline]

Definition at line 59 of file mlImageFormatCompressionParams.h.

const BoolField* const ml::MLImageFormatCompressionParams::getStrHintVisibleFlds ( ) const [inline]

Definition at line 62 of file mlImageFormatCompressionParams.h.

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

Update 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.

void ml::MLImageFormatCompressionParams::resetCompressionParams ( )

Reset _compressionFld, _tagListFld, and all _tagListFld.

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.

void ml::MLImageFormatCompressionParams::updateHintFieldsOrArgs	(	bool	updateFields,
		DataCompressor *	compressor
	)

Update the compressor args or the hint fields from the current compressor settings.

If updateFields is true then they are reset to the state of the current compressor settings, otherwise the _compressorArgs are set corresponding to the state of the fields contents. If compressor is NULL then all hint fields are reset to their default state.