FieldAddOn class supporting inheritance and optional writing of a boolean tag value. More...

#include <mlDicomBoolInheritAndWriteTagInterface.h>

Inheritance diagram for ml::DicomBoolInheritAndWriteTagInterface:

Public Types
enum	{ NumInheritModes = 3 }
	Number of available InheritModes. More...

enum	InheritMode { DoNotInherit =0 , InheritFromTopLevel , InheritRecursively }
	Enumerator for the _inheritValueFld. 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
	DicomBoolInheritAndWriteTagInterface (Module &modRef, const DCMTree::RawTagId tagId, const std::string &valueFieldName, const std::string &fieldSuffix, const std::string &dicomModuleInfoString="", const bool valueFldDefault=false, const bool writeFldDefault=false, const InheritMode inheritModeFldDefault=InheritFromTopLevel, const bool defaultFldDefault=false, const bool updateWriteOnInheritFldDefault=true, const bool alwaysWrite=false)
	Constructor, setting the reference of the module for which the fields shall be managed. More...

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

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

std::string	applyModifications (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos=nullptr) override
	See DicomModifyFieldAddOnBase::applyModifications() for documentation. More...

FieldAddOnBase::FieldChangeState	handleFieldChanges (Field *field) override
	Handle field notifications. More...

std::string	checkConsistency () const override
	Checks for invalid parameters; return textual description on error, or empty string on success. More...

virtual BoolField &	getValueFld ()
	See _valueFld. More...

virtual const BoolField &	getValueFld () const
	Constant read-only access, see _valueFld. More...

virtual BoolField &	getWriteFld ()
	See _writeFld. More...

virtual const BoolField &	getWriteFld () const
	Constant read-only access, see _writeFld. More...

virtual EnumField &	getInheritModeFld ()
	See _inheritModeFld. More...

virtual const EnumField &	getInheritModeFld () const
	Constant read-only access, see _inheritModeFld. More...

virtual BoolField &	getDefaultValueFld ()
	See _defaultValueFld. More...

virtual const BoolField &	getDefaultValueFld () const
	Constant read-only access, see _defaultValueFld. More...

virtual BoolField &	getUpdateWriteOnInheritFld ()
	See _updateWriteOnInheritFld. More...

virtual const BoolField &	getUpdateWriteOnInheritFld () const
	Constant read-only access, see _updateWriteOnInheritFld. 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...

void	handleFieldActivationChanges () override
	Handle class changes according to Module::activateAttachments. 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...

Static Public Attributes
static const char *const	InheritModeStrings [NumInheritModes]
	String representations for the _inheritModeFld. More...

Protected Attributes
const DCMTree::RawTagId	_tagId
	Stores the ID of the DICOM tag to be managed. More...

const std::string	_valueFieldName
	Name of the value field. More...

const std::string	_fieldSuffix
	Field suffix. More...

const std::string	_dicomModuleInfoString
	Stores the description of the DICOM module for error message generation. More...

const bool	_valueFldDefault
	Corresponding default passed to constructor. More...

const bool	_writeFldDefault
	Corresponding default passed to constructor. More...

const InheritMode	_inheritModeFldDefault
	Corresponding default passed to constructor. More...

const bool	_defaultValueFldDefault
	Corresponding default passed to constructor. More...

const bool	_updateWriteOnInheritFldDefault
	Corresponding default passed to constructor. More...

BoolField *	_valueFld
	The (tag) value to be managed. More...

BoolField *	_writeFld
	Controls whether the value is written or not as tag in applyModification(). More...

EnumField *	_inheritModeFld
	Controls whether or how the value is inherited. More...

BoolField *	_defaultValueFld
	The value to be inherited if no or only a bad value can be inherited. More...

BoolField *	_updateWriteOnInheritFld
	The value to be inherited if no or only a bad value can be inherited. More...

const bool	_alwaysWrite
	If true then the tag is always written, independent of the state of the write field. 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

FieldAddOn class supporting inheritance and optional writing of a boolean tag value.

Definition at line 24 of file mlDicomBoolInheritAndWriteTagInterface.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Number of available InheritModes.

Enumerator
NumInheritModes

Definition at line 30 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ InheritMode

enum ml::DicomBoolInheritAndWriteTagInterface::InheritMode

Enumerator for the _inheritValueFld.

Enumerator
DoNotInherit	Do not inherit value from input, leave it unchanged.
InheritFromTopLevel	Inherit value from top level of DCMTree or use the default value if not found or invalid.
InheritRecursively	Inherit value from recursively search in DCMTree or use the default value if not found or invalid.

Definition at line 33 of file mlDicomBoolInheritAndWriteTagInterface.h.

Constructor & Destructor Documentation

◆ DicomBoolInheritAndWriteTagInterface()

ml::DicomBoolInheritAndWriteTagInterface::DicomBoolInheritAndWriteTagInterface	(	Module &	modRef,
		const DCMTree::RawTagId	tagId,
		const std::string &	valueFieldName,
		const std::string &	fieldSuffix,
		const std::string &	dicomModuleInfoString = `""`,
		const bool	valueFldDefault = `false`,
		const bool	writeFldDefault = `false`,
		const InheritMode	inheritModeFldDefault = `InheritFromTopLevel`,
		const bool	defaultFldDefault = `false`,
		const bool	updateWriteOnInheritFldDefault = `true`,
		const bool	alwaysWrite = `false`
	)

Constructor, setting the reference of the module for which the fields shall be managed.

Parameters

modRef	The reference to the ML Module instance in which this FieldAdddOn will be inserted.
tagId	The 32 bit tag id of the DICOM tag to be managed.
valueFieldName	The name of the value field itself.
fieldSuffix	The suffix for all other fields to make the multiply usable without name collisions.
dicomModuleInfoString	Optional information string explaining from which DICOM module or macro the tag comes from; will be used for error message generation and can be left empty.
valueFldDefault	Value used to initialize the value field.
writeFldDefault	If true then the tag value is written in applyModifications, otherwise not.
inheritModeFldDefault	The default value for _inheritModeFld.
defaultFldDefault	Value used to initialize the defaultValue field.
updateWriteOnInheritFldDefault	Value used to initialize the defaultValue field.
alwaysWrite	If true then the tag is always written independent of the state of getWriteFld().

Member Function Documentation

◆ addFields()

void ml::DicomBoolInheritAndWriteTagInterface::addFields ( )

overridevirtual

Add fields to field container of module.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ applyModifications()

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

overridevirtual

See DicomModifyFieldAddOnBase::applyModifications() for documentation.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ checkConsistency()

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

overridevirtual

Checks for invalid parameters; return textual description on error, or empty string on success.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ getDefaultValueFld() [1/2]

virtual BoolField& ml::DicomBoolInheritAndWriteTagInterface::getDefaultValueFld ( )

inlinevirtual

See _defaultValueFld.

Definition at line 103 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ getDefaultValueFld() [2/2]

virtual const BoolField& ml::DicomBoolInheritAndWriteTagInterface::getDefaultValueFld ( ) const

inlinevirtual

Constant read-only access, see _defaultValueFld.

Definition at line 105 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ getInheritModeFld() [1/2]

virtual EnumField& ml::DicomBoolInheritAndWriteTagInterface::getInheritModeFld ( )

inlinevirtual

See _inheritModeFld.

Definition at line 98 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ getInheritModeFld() [2/2]

virtual const EnumField& ml::DicomBoolInheritAndWriteTagInterface::getInheritModeFld ( ) const

inlinevirtual

Constant read-only access, see _inheritModeFld.

Definition at line 100 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ getUpdateWriteOnInheritFld() [1/2]

virtual BoolField& ml::DicomBoolInheritAndWriteTagInterface::getUpdateWriteOnInheritFld ( )

inlinevirtual

See _updateWriteOnInheritFld.

Definition at line 108 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ getUpdateWriteOnInheritFld() [2/2]

virtual const BoolField& ml::DicomBoolInheritAndWriteTagInterface::getUpdateWriteOnInheritFld ( ) const

inlinevirtual

Constant read-only access, see _updateWriteOnInheritFld.

Definition at line 110 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ getValueFld() [1/2]

virtual BoolField& ml::DicomBoolInheritAndWriteTagInterface::getValueFld ( )

inlinevirtual

See _valueFld.

Definition at line 88 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ getValueFld() [2/2]

virtual const BoolField& ml::DicomBoolInheritAndWriteTagInterface::getValueFld ( ) const

inlinevirtual

Constant read-only access, see _valueFld.

Definition at line 90 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ getWriteFld() [1/2]

virtual BoolField& ml::DicomBoolInheritAndWriteTagInterface::getWriteFld ( )

inlinevirtual

See _writeFld.

Definition at line 93 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ getWriteFld() [2/2]

virtual const BoolField& ml::DicomBoolInheritAndWriteTagInterface::getWriteFld ( ) const

inlinevirtual

Constant read-only access, see _writeFld.

Definition at line 95 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ handleFieldChanges()

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

overridevirtual

Handle field notifications.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ inheritValues()

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

overridevirtual

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

Reimplemented from ml::DicomModifyFieldAddOnBase.

Member Data Documentation

◆ _alwaysWrite

const bool ml::DicomBoolInheritAndWriteTagInterface::_alwaysWrite

protected

If true then the tag is always written, independent of the state of the write field.

Definition at line 156 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ _defaultValueFld

BoolField* ml::DicomBoolInheritAndWriteTagInterface::_defaultValueFld

protected

The value to be inherited if no or only a bad value can be inherited.

Definition at line 150 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ _defaultValueFldDefault

const bool ml::DicomBoolInheritAndWriteTagInterface::_defaultValueFldDefault

protected

Corresponding default passed to constructor.

Definition at line 135 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ _dicomModuleInfoString

const std::string ml::DicomBoolInheritAndWriteTagInterface::_dicomModuleInfoString

protected

Stores the description of the DICOM module for error message generation.

Definition at line 123 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ _fieldSuffix

const std::string ml::DicomBoolInheritAndWriteTagInterface::_fieldSuffix

protected

Field suffix.

Definition at line 120 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ _inheritModeFld

EnumField* ml::DicomBoolInheritAndWriteTagInterface::_inheritModeFld

protected

Controls whether or how the value is inherited.

Definition at line 147 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ _inheritModeFldDefault

const InheritMode ml::DicomBoolInheritAndWriteTagInterface::_inheritModeFldDefault

protected

Corresponding default passed to constructor.

Definition at line 132 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ _tagId

const DCMTree::RawTagId ml::DicomBoolInheritAndWriteTagInterface::_tagId

protected

Stores the ID of the DICOM tag to be managed.

Definition at line 114 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ _updateWriteOnInheritFld

BoolField* ml::DicomBoolInheritAndWriteTagInterface::_updateWriteOnInheritFld

protected

The value to be inherited if no or only a bad value can be inherited.

Definition at line 153 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ _updateWriteOnInheritFldDefault

const bool ml::DicomBoolInheritAndWriteTagInterface::_updateWriteOnInheritFldDefault

protected

Corresponding default passed to constructor.

Definition at line 138 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ _valueFieldName

const std::string ml::DicomBoolInheritAndWriteTagInterface::_valueFieldName

protected

Name of the value field.

Definition at line 117 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ _valueFld

BoolField* ml::DicomBoolInheritAndWriteTagInterface::_valueFld

protected

The (tag) value to be managed.

Definition at line 141 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ _valueFldDefault

const bool ml::DicomBoolInheritAndWriteTagInterface::_valueFldDefault

protected

Corresponding default passed to constructor.

Definition at line 126 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ _writeFld

BoolField* ml::DicomBoolInheritAndWriteTagInterface::_writeFld

protected

Controls whether the value is written or not as tag in applyModification().

Definition at line 144 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ _writeFldDefault

const bool ml::DicomBoolInheritAndWriteTagInterface::_writeFldDefault

protected

Corresponding default passed to constructor.

Definition at line 129 of file mlDicomBoolInheritAndWriteTagInterface.h.

◆ InheritModeStrings

const char* const ml::DicomBoolInheritAndWriteTagInterface::InheritModeStrings[NumInheritModes]

static

String representations for the _inheritModeFld.

Definition at line 42 of file mlDicomBoolInheritAndWriteTagInterface.h.

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

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

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ InheritMode

Constructor & Destructor Documentation

◆ DicomBoolInheritAndWriteTagInterface()

Member Function Documentation

◆ addFields()

◆ applyModifications()

◆ checkConsistency()

◆ getDefaultValueFld() [1/2]

◆ getDefaultValueFld() [2/2]

◆ getInheritModeFld() [1/2]

◆ getInheritModeFld() [2/2]

◆ getUpdateWriteOnInheritFld() [1/2]

◆ getUpdateWriteOnInheritFld() [2/2]

◆ getValueFld() [1/2]

◆ getValueFld() [2/2]

◆ getWriteFld() [1/2]

◆ getWriteFld() [2/2]

◆ handleFieldChanges()

◆ inheritValues()

Member Data Documentation

◆ _alwaysWrite

◆ _defaultValueFld

◆ _defaultValueFldDefault

◆ _dicomModuleInfoString

◆ _fieldSuffix

◆ _inheritModeFld

◆ _inheritModeFldDefault

◆ _tagId

◆ _updateWriteOnInheritFld

◆ _updateWriteOnInheritFldDefault

◆ _valueFieldName

◆ _valueFld

◆ _valueFldDefault

◆ _writeFld

◆ _writeFldDefault

◆ InheritModeStrings