A concrete class derived from DicomModifyBase which allows some operations on tag groups in a (cloned) DICOM tree such as removal or modification of all Type 2 or Type 3 tags. More...

#include <mlDicomModifyOtherTagOperations.h>

Inheritance diagram for ml::DicomModifyOtherTagOperations:

Public Member Functions
	DicomModifyOtherTagOperations (const std::string &modStrVal="", DICOMTagTools::OtherTagModificationModes modMode=DICOMTagTools::OtherTagDoNotModify)
	Constructor setting ModificationStringValue and ModificationMode. More...

void	setModificationMode (DICOMTagTools::OtherTagModificationModes modMode)
	Sets how the tag with given id and modification value shall be modified. More...

DICOMTagTools::OtherTagModificationModes	getModificationMode () const
	Returns the currently set modification mode. More...

std::string	applyModifications (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos=nullptr) override
	Apply a change to dcmTree according to the currently selected _modificationMode. More...

Public Member Functions inherited from ml::DicomModifyBase
	DicomModifyBase (DCMTree::TagId tagId=DCMTree::TagId(), const std::string &modStrVal="")
	Constructor setting the tag ID and the string value for modifications. More...

virtual	~DicomModifyBase ()
	Virtual destructor. More...

void	setTagId (DCMTree::TagId tagId)
	Set the id of the tag to be modified. More...

void	setTagId (const std::string &tagIdStr)
	Set the id (as std::string) of the tag to be modified; invalid ids will cause an ML_ERROR_PRINT, empty strings shall be ignored by specification and will set an id (0000,0000). More...

DCMTree::TagId	getTagId () const
	Returns the id of the tag to be modified (might be temporarily overridden be a "modificationTagIdReplacement" field in treeInfos parameter of applyModifications()). More...

void	setModificationStringValue (const std::string &modStrVal)
	Set the string value to be used for the tag modification if not overridden by a treeInfos-"modificationStringValueReplacement" entry as described in applyModifications. More...

const std::string &	getModificationStringValue () const
	Returns the string which is used to manipulate tag value(s) (might be temporarily overridden by a "modificationStringValueReplacement" field in treeInfos parameter of applyModifications()). More...

bool	getModificationStringValueAsMLInt (MLint &retVal) const
	If the modificationStringValue() can be interpreted as an integer value then true is returned and the string is converted to that integer and returned in retVal; otherwise false is returned and retVal is left unchanged. More...

void	setTagIdAndModificationStringValue (DCMTree::TagId tagId, const std::string &modStrVal)
	Calls setTagId(tagId) and setModificationStringValue(modStrVal). More...

bool	tagExists (DCMTree::TreePtr dcmTree) const

DCMTree::TagPtr	getTagIfItExists (DCMTree::TreePtr dcmTree, std::string *errStr=nullptr) const

DCMTree::TagPtr	addTag (DCMTree::TreePtr dcmTree, std::string *errStr=nullptr, bool setValue=true, bool splitValue=false) const
	Add the tag with ID getTagId() to tree dcmTree and value _modificationStringValue; requires a valid non nullptr dcmTree. More...

void	removeTag (DCMTree::TreePtr dcmTree) const
	Remove the tag with the ID getTagId() if it exists, otherwise do nothing; (if dcmTree member is nullptr the call is ignored). More...

void	setTagValue (DCMTree::TreePtr dcmTree, std::string *errStr=nullptr, const DICOMTagTools::ValueModifyModes modMode=DICOMTagTools::Replace, bool splitValue=false) const
	Sets the value of tag with getTagId() in dcmTree with new value _modificationStringValue. More...

Detailed Description

A concrete class derived from DicomModifyBase which allows some operations on tag groups in a (cloned) DICOM tree such as removal or modification of all Type 2 or Type 3 tags.

Definition at line 26 of file mlDicomModifyOtherTagOperations.h.

Constructor & Destructor Documentation

◆ DicomModifyOtherTagOperations()

ml::DicomModifyOtherTagOperations::DicomModifyOtherTagOperations	(	const std::string &	modStrVal = `""`,
		DICOMTagTools::OtherTagModificationModes	modMode = `DICOMTagTools::OtherTagDoNotModify`
	)

Constructor setting ModificationStringValue and ModificationMode.

Member Function Documentation

◆ applyModifications()

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

overridevirtual

Apply a change to dcmTree according to the currently selected _modificationMode.

Parameters

dcmTree	The DICOM tree to be modified.
treeInfos	A FieldContainer which - if not nullptr - can contain additional user defined information fields about dcmTree.

Returns: An empty string on success, otherwise a cumulative descriptive string of all problems.

Reimplemented from ml::DicomModifyBase.

◆ getModificationMode()

DICOMTagTools::OtherTagModificationModes ml::DicomModifyOtherTagOperations::getModificationMode ( ) const

Returns the currently set modification mode.

◆ setModificationMode()

void ml::DicomModifyOtherTagOperations::setModificationMode ( DICOMTagTools::OtherTagModificationModes modMode )

Sets how the tag with given id and modification value shall be modified.

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

FMEstable/ReleaseMeVis/Projects/DICOM/MLDicomModify/Sources/mlDicomModifyOtherTagOperations.h