Provides control to copy/inherit a set of tag (values) from an input DCMTree, buffer it, and add it to the output tree. More...

#include <mlDicomCopyTagSetInterface.h>

Inheritance diagram for ml::DicomCopyTagSetInterface:

Public Member Functions
	DicomCopyTagSetInterface (Module &modRef, const std::string &fieldSuffix)
	Constructor, setting the reference of the module for which the fields shall be managed and the suffix to be used for all fields. 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 details. More...

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

virtual BoolField &	getInheritAndCopyTagsFld ()
	Provides modification access to _inheritAndCopyTagsFld; only allowed after addFields(). More...

virtual const BoolField &	getInheritAndCopyTagsFld () const
	Provides constant read-only access to _inheritAndCopyTagsFld; only allowed after addFields(). More...

virtual const std::string &	getFieldSuffix () const
	Provides constant read-only access to _fieldSuffix. More...

virtual std::set< DCMTree::RawTagId > &	getTagIdSet ()
	Provides modification access to _tagIdSet. More...

virtual const std::set< DCMTree::RawTagId > &	getTagIdSet () const
	Provides constant read-only access to _tagIdSet. More...

virtual std::map< DCMTree::RawTagId, DCMTree::Const_TagPtr > &	getTagMap ()
	Provides modification access to _tagMap. More...

virtual const std::map< DCMTree::RawTagId, DCMTree::Const_TagPtr > &	getTagMap () const
	Provides constant read-only access to _tagMap. 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...

virtual std::string	checkConsistency () const
	Checks for invalid parameters; return textual description on error, or empty string on success. 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...

Protected Attributes
std::string	_fieldSuffix
	The suffix to be appended to names of all fields to be added. More...

BoolField *	_inheritAndCopyTagsFld
	If enabled then the tags specified in getTagIdSet() are inherited from the input DCMTree in inheritValues(), buffered, and added to the output dcmTree in applyModifications(). More...

std::set< DCMTree::RawTagId >	_tagIdSet
	Set of tags to be copied, buffered, and/or added to the output. More...

std::map< DCMTree::RawTagId, DCMTree::Const_TagPtr >	_tagMap
	Set of tags to be copied, buffered, and/or added to the output. More...

Additional Inherited Members
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...

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

Provides control to copy/inherit a set of tag (values) from an input DCMTree, buffer it, and add it to the output tree.

Definition at line 24 of file mlDicomCopyTagSetInterface.h.

Constructor & Destructor Documentation

◆ DicomCopyTagSetInterface()

ml::DicomCopyTagSetInterface::DicomCopyTagSetInterface	(	Module &	modRef,
		const std::string &	fieldSuffix
	)

Constructor, setting the reference of the module for which the fields shall be managed and the suffix to be used for all fields.

Member Function Documentation

◆ addFields()

void ml::DicomCopyTagSetInterface::addFields ( )

overridevirtual

Add fields to field container of module.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ applyModifications()

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

overridevirtual

See DicomModifyFieldAddOnBase::applyModifications() for details.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ getFieldSuffix()

virtual const std::string& ml::DicomCopyTagSetInterface::getFieldSuffix ( ) const

inlinevirtual

Provides constant read-only access to _fieldSuffix.

Definition at line 50 of file mlDicomCopyTagSetInterface.h.

◆ getInheritAndCopyTagsFld() [1/2]

virtual BoolField& ml::DicomCopyTagSetInterface::getInheritAndCopyTagsFld ( )

inlinevirtual

Provides modification access to _inheritAndCopyTagsFld; only allowed after addFields().

Definition at line 45 of file mlDicomCopyTagSetInterface.h.

◆ getInheritAndCopyTagsFld() [2/2]

virtual const BoolField& ml::DicomCopyTagSetInterface::getInheritAndCopyTagsFld ( ) const

inlinevirtual

Provides constant read-only access to _inheritAndCopyTagsFld; only allowed after addFields().

Definition at line 47 of file mlDicomCopyTagSetInterface.h.

◆ getTagIdSet() [1/2]

virtual std::set<DCMTree::RawTagId>& ml::DicomCopyTagSetInterface::getTagIdSet ( )

inlinevirtual

Provides modification access to _tagIdSet.

Definition at line 53 of file mlDicomCopyTagSetInterface.h.

◆ getTagIdSet() [2/2]

virtual const std::set<DCMTree::RawTagId>& ml::DicomCopyTagSetInterface::getTagIdSet ( ) const

inlinevirtual

Provides constant read-only access to _tagIdSet.

Definition at line 55 of file mlDicomCopyTagSetInterface.h.

◆ getTagMap() [1/2]

virtual std::map<DCMTree::RawTagId, DCMTree::Const_TagPtr>& ml::DicomCopyTagSetInterface::getTagMap ( )

inlinevirtual

Provides modification access to _tagMap.

Definition at line 58 of file mlDicomCopyTagSetInterface.h.

◆ getTagMap() [2/2]

virtual const std::map<DCMTree::RawTagId, DCMTree::Const_TagPtr>& ml::DicomCopyTagSetInterface::getTagMap ( ) const

inlinevirtual

Provides constant read-only access to _tagMap.

Definition at line 60 of file mlDicomCopyTagSetInterface.h.

◆ handleFieldChanges()

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

overridevirtual

Handle field notifications.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ inheritValues()

void ml::DicomCopyTagSetInterface::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

◆ _fieldSuffix

std::string ml::DicomCopyTagSetInterface::_fieldSuffix

protected

The suffix to be appended to names of all fields to be added.

Definition at line 64 of file mlDicomCopyTagSetInterface.h.

◆ _inheritAndCopyTagsFld

BoolField* ml::DicomCopyTagSetInterface::_inheritAndCopyTagsFld

protected

If enabled then the tags specified in getTagIdSet() are inherited from the input DCMTree in inheritValues(), buffered, and added to the output dcmTree in applyModifications().

Definition at line 68 of file mlDicomCopyTagSetInterface.h.

◆ _tagIdSet

std::set<DCMTree::RawTagId> ml::DicomCopyTagSetInterface::_tagIdSet

protected

Set of tags to be copied, buffered, and/or added to the output.

Definition at line 71 of file mlDicomCopyTagSetInterface.h.

◆ _tagMap

std::map<DCMTree::RawTagId, DCMTree::Const_TagPtr> ml::DicomCopyTagSetInterface::_tagMap

protected

Set of tags to be copied, buffered, and/or added to the output.

Definition at line 74 of file mlDicomCopyTagSetInterface.h.

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DicomCopyTagSetInterface()

Member Function Documentation

◆ addFields()

◆ applyModifications()

◆ getFieldSuffix()

◆ getInheritAndCopyTagsFld() [1/2]

◆ getInheritAndCopyTagsFld() [2/2]

◆ getTagIdSet() [1/2]

◆ getTagIdSet() [2/2]

◆ getTagMap() [1/2]

◆ getTagMap() [2/2]

◆ handleFieldChanges()

◆ inheritValues()

Member Data Documentation

◆ _fieldSuffix

◆ _inheritAndCopyTagsFld

◆ _tagIdSet

◆ _tagMap