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

void	updateHintFieldsFromCompressor (DataCompressor *compressor)
	Set up all hint fields and their visibility according to the compressor configuration. More...

void	updateHintVisibility (const DataCompressor *compressor)
	Sets visibility and hint name fields according to the given compressor configuration. More...

void	updateCompressorArgsFromHintFields (const DataCompressor *compressor)
	Clears the compressor arguments and updates them with new values from those hint fields which are valid according to the given compressor configuration. More...

void	handleCompressionFieldChanges (Field *field)
	Update the compressor and the fields showing compression parameters. More...

void	updateCompressionFieldsToLoaderState (const MLImageFormat &loader)
	Helper function to update compression fields to the compressor settings of the the passed loader. More...

void	resetCompressionParams ()
	Reset _compressionFld, _tagListFld, and all _tagListFld. More...

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

std::vector< std::string >	_compressorNames
	List of available compressor names stored when creating the module. More...

MLImageFormatTagList	_compressorArgs
	List of tags used as parameters for compressors. More...

EnumField *	_compressorNameFld
	Compression scheme used for stored image data, default is first entry. More...

NotifyField *	_updateHintControlsFld
	Field to notify a possible gui layouter of the modules to update the visibility and name displays of the controls of the hint fields. More...

Optional compression arguments used dependent on the hint settings of the compressor.
StringField *	_hintNameFld [DataCompressor::MaxHints]
	Name of the parameter. More...

DoubleField *	_dblHintValFld [DataCompressor::MaxHints]
	Value of double parameter. More...

IntField *	_intHintValFld [DataCompressor::MaxHints]
	Value of integer parameter. More...

StringField *	_strHintValFld [DataCompressor::MaxHints]
	Value of string parameter. More...

BoolField *	_boolHintValFld [DataCompressor::MaxHints]
	Value of bool parameter. More...

BoolField *	_intHintVisibleFld [DataCompressor::MaxHints]
	Controls visibility of integer parameter. More...

BoolField *	_strHintVisibleFld [DataCompressor::MaxHints]
	Controls visibility of string parameter. More...

BoolField *	_dblHintVisibleFld [DataCompressor::MaxHints]
	Controls visibility of double parameter. More...

BoolField *	_boolHintVisibleFld [DataCompressor::MaxHints]
	Controls visibility of boolean parameter. More...

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.

◆ getBoolHintVisibleFlds()

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

inline

Definition at line 58 of file mlImageFormatCompressionParams.h.

◆ getCompressorArgs()

MLImageFormatTagList& ml::MLImageFormatCompressionParams::getCompressorArgs ( )

inline

Definition at line 49 of file mlImageFormatCompressionParams.h.

◆ getCompressorNameFld()

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

inline

Definition at line 46 of file mlImageFormatCompressionParams.h.

◆ getCompressorNames()

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

inline

Definition at line 48 of file mlImageFormatCompressionParams.h.

◆ getDblHintValFlds()

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

inline

Definition at line 51 of file mlImageFormatCompressionParams.h.

◆ getDblHintVisibleFlds()

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

inline

Definition at line 57 of file mlImageFormatCompressionParams.h.

◆ getHintNameFlds()

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

inline

Definition at line 50 of file mlImageFormatCompressionParams.h.

◆ getIntHintValFlds()

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

inline

Definition at line 52 of file mlImageFormatCompressionParams.h.

◆ getIntHintVisibleFlds()

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

inline

Definition at line 55 of file mlImageFormatCompressionParams.h.

◆ getStrHintValFlds()

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

inline

Definition at line 53 of file mlImageFormatCompressionParams.h.

◆ getStrHintVisibleFlds()

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

inline

Definition at line 56 of file mlImageFormatCompressionParams.h.

◆ getUpdateHintControlsFld()

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

inline

Definition at line 47 of file mlImageFormatCompressionParams.h.

◆ handleCompressionFieldChanges()

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.

◆ 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 which 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 )

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

Member Data Documentation

◆ _baseOp

Module& ml::MLImageFormatCompressionParams::_baseOp

protected

Reference to the related Module.

Definition at line 93 of file mlImageFormatCompressionParams.h.

◆ _boolHintValFld

BoolField* ml::MLImageFormatCompressionParams::_boolHintValFld[DataCompressor::MaxHints]

protected

Value of bool parameter.

Definition at line 119 of file mlImageFormatCompressionParams.h.

◆ _boolHintVisibleFld

BoolField* ml::MLImageFormatCompressionParams::_boolHintVisibleFld[DataCompressor::MaxHints]

protected

Controls visibility of boolean parameter.

Definition at line 124 of file mlImageFormatCompressionParams.h.

◆ _compressorArgs

MLImageFormatTagList ml::MLImageFormatCompressionParams::_compressorArgs

protected

List of tags used as parameters for compressors.

Definition at line 100 of file mlImageFormatCompressionParams.h.

◆ _compressorNameFld

EnumField* ml::MLImageFormatCompressionParams::_compressorNameFld

protected

Compression scheme used for stored image data, default is first entry.

Definition at line 106 of file mlImageFormatCompressionParams.h.

◆ _compressorNames

std::vector<std::string> ml::MLImageFormatCompressionParams::_compressorNames

protected

List of available compressor names stored when creating the module.

Definition at line 97 of file mlImageFormatCompressionParams.h.

◆ _dblHintValFld

DoubleField* ml::MLImageFormatCompressionParams::_dblHintValFld[DataCompressor::MaxHints]

protected

Value of double parameter.

Definition at line 116 of file mlImageFormatCompressionParams.h.

◆ _dblHintVisibleFld

BoolField* ml::MLImageFormatCompressionParams::_dblHintVisibleFld[DataCompressor::MaxHints]

protected

Controls visibility of double parameter.

Definition at line 123 of file mlImageFormatCompressionParams.h.

◆ _hintNameFld

StringField* ml::MLImageFormatCompressionParams::_hintNameFld[DataCompressor::MaxHints]

protected

Name of the parameter.

Definition at line 114 of file mlImageFormatCompressionParams.h.

◆ _intHintValFld

IntField* ml::MLImageFormatCompressionParams::_intHintValFld[DataCompressor::MaxHints]

protected

Value of integer parameter.

Definition at line 117 of file mlImageFormatCompressionParams.h.

◆ _intHintVisibleFld

BoolField* ml::MLImageFormatCompressionParams::_intHintVisibleFld[DataCompressor::MaxHints]

protected

Controls visibility of integer parameter.

Definition at line 121 of file mlImageFormatCompressionParams.h.

◆ _strHintValFld

StringField* ml::MLImageFormatCompressionParams::_strHintValFld[DataCompressor::MaxHints]

protected

Value of string parameter.

Definition at line 118 of file mlImageFormatCompressionParams.h.

◆ _strHintVisibleFld

BoolField* ml::MLImageFormatCompressionParams::_strHintVisibleFld[DataCompressor::MaxHints]

protected

Controls visibility of string parameter.

Definition at line 122 of file mlImageFormatCompressionParams.h.

◆ _updateHintControlsFld

NotifyField* ml::MLImageFormatCompressionParams::_updateHintControlsFld

protected

Field to notify a possible gui layouter of the modules to update the visibility and name displays of the controls of the hint fields.

Definition at line 110 of file mlImageFormatCompressionParams.h.

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

MeVis/Foundation/Sources/MLImageFormatBase/mlImageFormatCompressionParams.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MLImageFormatCompressionParams()

Member Function Documentation

◆ getBoolHintValFlds()

◆ getBoolHintVisibleFlds()

◆ getCompressorArgs()

◆ getCompressorNameFld()

◆ getCompressorNames()

◆ getDblHintValFlds()

◆ getDblHintVisibleFlds()

◆ getHintNameFlds()

◆ getIntHintValFlds()

◆ getIntHintVisibleFlds()

◆ getStrHintValFlds()

◆ getStrHintVisibleFlds()

◆ getUpdateHintControlsFld()

◆ handleCompressionFieldChanges()

◆ resetCompressionParams()

◆ updateCompressionFieldsToLoaderState()

◆ updateCompressorArgsFromHintFields()

◆ updateHintFieldsFromCompressor()

◆ updateHintVisibility()

Member Data Documentation

◆ _baseOp

◆ _boolHintValFld

◆ _boolHintVisibleFld

◆ _compressorArgs

◆ _compressorNameFld

◆ _compressorNames

◆ _dblHintValFld

◆ _dblHintVisibleFld

◆ _hintNameFld

◆ _intHintValFld

◆ _intHintVisibleFld

◆ _strHintValFld

◆ _strHintVisibleFld

◆ _updateHintControlsFld