Manages the module field interface according to the Image Type tag from DICOM Enhanced MR Image Modules C.8.13.1. More...

#include <mlDicomImageTypeTagInterface.h>

Inheritance diagram for ml::DicomImageTypeTagInterface:

Public Types
enum	IODMode { ImageTypeforLegacyConvertedEnhancedMR = 0 }
	Defined the mode how the up to four values are configured and filled with values on construction time. More...

Public Types inherited from ml::Base
enum	PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
	This enum describes the different persistence interfaces available. More...

Public Types inherited from ml::FieldAddOnBase
enum	FieldChangeState { NoChange = 0 , StatusOnlyChange , RecalculationRequired }
	Describes the type of a field changes detected in handleFieldChanges(Field *field). More...

Public Member Functions
	DicomImageTypeTagInterface (Module &modRef, const IODMode iodMode, bool forbidMixed, const bool allowEmptyValue3=false, const bool allowEmptyValue4=false)
	Constructor, setting the reference of the module modRef for which the fields shall be managed; iodMode defines for which IOD the AddOn shall be configured; if forbidMixed is true then the class will handle MIXED values for first and last value as error. More...

void	addFields () override
	Add fields to field container of module. More...

void	handleFieldActivationChanges () override
	Handle class changes according to Module::activateAttachments. More...

FieldAddOnBase::FieldChangeState	handleFieldChanges (Field *field) override
	Handle field notifications according to Module::activateAttachments with a return of field change state. More...

void	inheritValues (DCMTree::Const_TreePtr dcmTree) override
	Implements the copy of tag values from the given dcmTree to the fields. More...

void	getAsTagVectorToAdd (std::vector< DCMTree::TagPtr > &tagVector, DCMTree::RawTagId idOfTagToAdd)
	For the current state get a vector with set tags which easily can be added to a DCMTree. More...

std::string	applyModifications (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos=nullptr) override
	See DicomModifyFieldAddOnBase::applyModifications() for documentation; adds field values as tags to dcmTree. More...

void	_addImageTypeSpecificTags (DCMTree::TreePtr dcmTree)
	Add tags of the Image Type tag from Enhanced MR Image Module, C.8.13.1. More...

std::string	checkConsistency () const override
	Checks for invalid parameters; return textual description on error, or empty string on success; requires that setInputPagedImage was called with a valid image before for successful proper operation. More...

bool	getForbidMixed () const
	Allow access to _forbidMixed flag. More...

void	setForbidMixed (bool forbidMixed)
	Set _forbidMixed flag. More...

Public Member Functions inherited from ml::DicomModifyFieldAddOnBase
	DicomModifyFieldAddOnBase (FieldContainer &fieldContainerRef, size_t numInstances=1, bool createInputModifyTagsPluginBaseConnectorField=false, bool createOutputModifyTagsPluginBaseConnectorField=false)
	Constructor, setting the reference of the FieldContainer managing the fields, the number of field instances to create and optionally input and output fields to create modification pipelines. More...

	~DicomModifyFieldAddOnBase () override
	Destructor resetting connector fields if they exist. More...

size_t	getNumInstances () const
	Returns the number of instances to be created by derived fields. More...

BaseField *	getOutputModifierListFld () const
	Provide access to output base field if it was created. More...

BaseField *	getInputModifierListFld () const
	Provide access to input base connector field if it was created. More...

Public Member Functions inherited from ml::DicomModifyList
	DicomModifyList ()
	Constructor creating an empty list of tag modifiers and setting the optional input plugin with a concatenated DicomModifyList. More...

	~DicomModifyList () override
	Destructor also destroying all of its stored Modifiers. More...

void	addModifier (DicomModifyBase *modifier, bool atEnd=true)
	Add an object derived from DicomModifyBase which then will be owned (and on destruction deleted) by this. More...

void	clear ()
	Makes modifier array empty and deletes all of them. More...

std::vector< DicomModifyBase * > &	getModifierList ()
	Get direct access to internal list to allow callers direct manipulations which, however, must obey the restriction that ownership belongs to *this, i.e. More...

const std::vector< DicomModifyBase * > &	getModifierList () const
	Same as getModifierList() only for constant access. More...

void	setInputPlugin (DicomModifyList *inputPlugin=nullptr)
	Sets an optional plugin to be called by applyModififcations or resets it to nullptr; the input is called after the objects in _modfiers list. More...

DicomModifyList *	getInputPlugin () const
	Returns the optional plugin to be called by applyModififcations. More...

Public Member Functions inherited from ml::Base
	Base ()
	Constructor. More...

virtual	~Base ()
	Destructor. More...

virtual Base *	deepCopy () const
	Set addStateToTree version number that can be accessed via getAddStateVersion() More...

bool	isOfAllowedType (const std::vector< const RuntimeType * > &types) const
	Check if this object's type is equal to or derived from one of the types given in the argument. More...

virtual bool	isRefCountedBase () const
	Returns if the instance is derived from RefCountedBase. More...

virtual std::string	detailString () const
	Return a string describing this object. More...

virtual bool	implementsPersistence (PersistenceInterface) const
	Override this method to declare which persistence interfaces are implemented by your derived class. More...

virtual std::string	persistentState () const
	Returns a string describing the object's internal state. More...

virtual void	setPersistentState (const std::string &state)
	Restores the object's internal state from a string that had been previously generated using `persistentState()`. More...

virtual void	addStateToTree (TreeNode *) const
	Attaches the object state as children of the given parent node. More...

virtual void	readStateFromTree (TreeNode *)
	Reads the object state from the children of the given parent node. More...

virtual void	writeTo (AbstractPersistenceOutputStream *) const
	Write the objects state to the data stream object. More...

virtual void	readFrom (AbstractPersistenceInputStream *, int)
	Read the objects state from the data stream object. More...

Public Member Functions inherited from ml::FieldAddOnBase
	FieldAddOnBase (FieldContainer &fieldContainerRef)
	Constructor, setting the reference of the FieldContainer managing the fields. More...

virtual	~FieldAddOnBase ()
	Destructor. More...

FieldContainer &	getFieldContainer ()
	Returns the referenced container. More...

const FieldContainer &	getFieldContainer () const
	Returns the referenced container. More...

std::vector< Field * > &	getFields ()
	Return modification access to the list of managed fields, use at own risk! More...

const std::vector< Field * > &	getFields () const
	Return constant access to the list of managed fields! More...

virtual FieldChangeState	getMergedFieldChangeState (FieldChangeState state1, FieldChangeState state2) const
	Returns a FieldChangeState which best represents a merge of the two given states. More...

virtual bool	hasField (Field *field) const
	Returns true if the passed fieldPtr is in _fieldPointers, otherwise false. More...

Public Attributes
DicomValueComboBoxSelectorTagInterface	imageTypeValue1AddOn
	Manager and access interface to fields related to first value of image type. More...

DicomValueComboBoxSelectorTagInterface	imageTypeValue2AddOn
	Manager and access interface to fields related to second value of image type. More...

DicomValueComboBoxSelectorTagInterface	imageTypeValue3AddOn
	Manager and access interface to fields related to third value of image type. More...

DicomValueComboBoxSelectorTagInterface	imageTypeValue4AddOn
	Manager and access interface to fields related to fourth value of image type. More...

Protected Attributes
const IODMode	_iodMode
	Selects the configuration for the internal fields and possible values. More...

bool	_forbidMixed
	If true then mixed frame types are not allowed. More...

const bool	_allowEmptyValue3
	If true then third value is allowed to be empty. More...

const bool	_allowEmptyValue4
	If true then fourth value is allowed to be empty. More...

Additional Inherited Members
Static Public Member Functions inherited from ml::DicomModifyFieldAddOnBase
static bool	isIn (const std::string &str, const char const values, size_t numValues)
	Static helper function which checks whether str is part of the given list of values which has numValues entries. More...

Protected Member Functions inherited from ml::Base
virtual char *	getPersistentState () const
	Returns a C string describing the object's internal state. More...

virtual void	setPersistentState (const char *)
	Restores the object's internal state from a string that had been previously generated using `getPersistentState()`. More...

virtual void	clearPersistentState (char *) const
	Disposes a string previously allocated by `getPersistentState()`. More...

Protected Member Functions inherited from ml::FieldAddOnBase
void	_addFieldPointer (Field *field)
	Helper routine to add a Field pointer to _fieldPointers, empty pointers and pointers added more than once will be handled fatally. More...

Detailed Description

Manages the module field interface according to the Image Type tag from DICOM Enhanced MR Image Modules C.8.13.1.

Definition at line 22 of file mlDicomImageTypeTagInterface.h.

Member Enumeration Documentation

◆ IODMode

enum ml::DicomImageTypeTagInterface::IODMode

Defined the mode how the up to four values are configured and filled with values on construction time.

Enumerator
ImageTypeforLegacyConvertedEnhancedMR	Configure for Enhanced LegacyConverted MR.

Definition at line 27 of file mlDicomImageTypeTagInterface.h.

Constructor & Destructor Documentation

◆ DicomImageTypeTagInterface()

ml::DicomImageTypeTagInterface::DicomImageTypeTagInterface	(	Module &	modRef,
		const IODMode	iodMode,
		bool	forbidMixed,
		const bool	allowEmptyValue3 = `false`,
		const bool	allowEmptyValue4 = `false`
	)

Constructor, setting the reference of the module modRef for which the fields shall be managed; iodMode defines for which IOD the AddOn shall be configured; if forbidMixed is true then the class will handle MIXED values for first and last value as error.

Member Function Documentation

◆ _addImageTypeSpecificTags()

void ml::DicomImageTypeTagInterface::_addImageTypeSpecificTags ( DCMTree::TreePtr dcmTree )

Add tags of the Image Type tag from Enhanced MR Image Module, C.8.13.1.

◆ addFields()

void ml::DicomImageTypeTagInterface::addFields ( )

overridevirtual

Add fields to field container of module.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ applyModifications()

std::string ml::DicomImageTypeTagInterface::applyModifications	(	DCMTree::TreePtr	dcmTree,
		const FieldContainer *	treeInfos = `nullptr`
	)

overridevirtual

See DicomModifyFieldAddOnBase::applyModifications() for documentation; adds field values as tags to dcmTree.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ checkConsistency()

std::string ml::DicomImageTypeTagInterface::checkConsistency ( ) const

overridevirtual

Checks for invalid parameters; return textual description on error, or empty string on success; requires that setInputPagedImage was called with a valid image before for successful proper operation.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ getAsTagVectorToAdd()

void ml::DicomImageTypeTagInterface::getAsTagVectorToAdd	(	std::vector< DCMTree::TagPtr > &	tagVector,
		DCMTree::RawTagId	idOfTagToAdd
	)

For the current state get a vector with set tags which easily can be added to a DCMTree.

◆ getForbidMixed()

bool ml::DicomImageTypeTagInterface::getForbidMixed ( ) const

Allow access to _forbidMixed flag.

◆ handleFieldActivationChanges()

void ml::DicomImageTypeTagInterface::handleFieldActivationChanges ( )

overridevirtual

Handle class changes according to Module::activateAttachments.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ handleFieldChanges()

FieldAddOnBase::FieldChangeState ml::DicomImageTypeTagInterface::handleFieldChanges ( Field * field )

overridevirtual

Handle field notifications according to Module::activateAttachments with a return of field change state.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ inheritValues()

void ml::DicomImageTypeTagInterface::inheritValues ( DCMTree::Const_TreePtr dcmTree )

overridevirtual

Implements the copy of tag values from the given dcmTree to the fields.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ setForbidMixed()

void ml::DicomImageTypeTagInterface::setForbidMixed ( bool forbidMixed )

Set _forbidMixed flag.

Member Data Documentation

◆ _allowEmptyValue3

const bool ml::DicomImageTypeTagInterface::_allowEmptyValue3

protected

If true then third value is allowed to be empty.

Definition at line 97 of file mlDicomImageTypeTagInterface.h.

◆ _allowEmptyValue4

const bool ml::DicomImageTypeTagInterface::_allowEmptyValue4

protected

If true then fourth value is allowed to be empty.

Definition at line 100 of file mlDicomImageTypeTagInterface.h.

◆ _forbidMixed

bool ml::DicomImageTypeTagInterface::_forbidMixed

protected

If true then mixed frame types are not allowed.

Definition at line 94 of file mlDicomImageTypeTagInterface.h.

◆ _iodMode

const IODMode ml::DicomImageTypeTagInterface::_iodMode

protected

Selects the configuration for the internal fields and possible values.

Definition at line 91 of file mlDicomImageTypeTagInterface.h.

◆ imageTypeValue1AddOn

DicomValueComboBoxSelectorTagInterface ml::DicomImageTypeTagInterface::imageTypeValue1AddOn

Manager and access interface to fields related to first value of image type.

Definition at line 71 of file mlDicomImageTypeTagInterface.h.

◆ imageTypeValue2AddOn

DicomValueComboBoxSelectorTagInterface ml::DicomImageTypeTagInterface::imageTypeValue2AddOn

Manager and access interface to fields related to second value of image type.

Definition at line 74 of file mlDicomImageTypeTagInterface.h.

◆ imageTypeValue3AddOn

DicomValueComboBoxSelectorTagInterface ml::DicomImageTypeTagInterface::imageTypeValue3AddOn

Manager and access interface to fields related to third value of image type.

Definition at line 77 of file mlDicomImageTypeTagInterface.h.

◆ imageTypeValue4AddOn

DicomValueComboBoxSelectorTagInterface ml::DicomImageTypeTagInterface::imageTypeValue4AddOn

Manager and access interface to fields related to fourth value of image type.

Definition at line 80 of file mlDicomImageTypeTagInterface.h.

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

FMEstable/ReleaseMeVis/Projects/DICOM/MLDicomTagInterfaces/Sources/DicomTagInterfaces/mlDicomImageTypeTagInterface.h

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ IODMode

Constructor & Destructor Documentation

◆ DicomImageTypeTagInterface()

Member Function Documentation

◆ _addImageTypeSpecificTags()

◆ addFields()

◆ applyModifications()

◆ checkConsistency()

◆ getAsTagVectorToAdd()

◆ getForbidMixed()

◆ handleFieldActivationChanges()

◆ handleFieldChanges()

◆ inheritValues()

◆ setForbidMixed()

Member Data Documentation

◆ _allowEmptyValue3

◆ _allowEmptyValue4

◆ _forbidMixed

◆ _iodMode

◆ imageTypeValue1AddOn

◆ imageTypeValue2AddOn

◆ imageTypeValue3AddOn

◆ imageTypeValue4AddOn