Class which manages a list of DicomModifyBase or derived objects, with an input for concatenation to another DicomModifyList object and which can apply their operations according to their parameters to DCMTrees. More...
#include <mlDicomModifyList.h>
Public Member Functions | |
| 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... | |
| virtual std::string | applyModifications (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos=nullptr) |
| Apply all DicomModify objects to dcmTree; the operations optionally defined with the input are performed after those from _modfiers list. 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... | |
Additional Inherited Members | |
| Public Types inherited from ml::Base | |
| enum | PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream } |
| This enum describes the different persistence interfaces available. 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... | |
Detailed Description
Class which manages a list of DicomModifyBase or derived objects, with an input for concatenation to another DicomModifyList object and which can apply their operations according to their parameters to DCMTrees.
Definition at line 28 of file mlDicomModifyList.h.
Constructor & Destructor Documentation
◆ DicomModifyList()
| ml::DicomModifyList::DicomModifyList | ( | ) |
Constructor creating an empty list of tag modifiers and setting the optional input plugin with a concatenated DicomModifyList.
◆ ~DicomModifyList()
|
override |
Destructor also destroying all of its stored Modifiers.
Member Function Documentation
◆ addModifier()
| void ml::DicomModifyList::addModifier | ( | DicomModifyBase * | modifier, |
| bool | atEnd = true |
||
| ) |
Add an object derived from DicomModifyBase which then will be owned (and on destruction deleted) by this.
If atEnd is true the object is appended at the end, otherwise it will be inserted as first element.
◆ applyModifications()
|
virtual |
Apply all DicomModify objects to dcmTree; the operations optionally defined with the input are performed after those from _modfiers list.
In derived versions the tag changes alternatively can also be implemented directly without modifiers.
- Parameters
-
dcmTree The DICOM tree to be modified. treeInfos A FieldContainer which - if not nullptr - can contain additional user defined information fields about dcmTree and the changes to be done.
- Returns
- An empty string on success, otherwise a cumulative descriptive string of all problems.
Reimplemented in ml::DicomValueInheritAndCreateTagInterface, ml::DicomValueComboBoxSelectorTagInterface, ml::DicomSpatialFiducialsModuleTagInterface, ml::DicomSOPInstanceReferenceMacroTagInterface, ml::DicomSOPCommonModuleTagInterface, ml::DicomSeriesAndInstanceReferenceMacroTagInterface, ml::DicomSegmentSequenceTagInterface, ml::DicomSegmentationSeriesModuleAttributesTagInterface, ml::DicomSegmentationImageModuleTagInterface, ml::DicomSCMultiframeImageModuleTagInterface, ml::DicomSCEquipmentModuleTagInterface, ml::DicomReferencedImageSequenceTagInterface, ml::DicomPatientModuleTagInterface, ml::DicomMRSeriesModuleTagInterface, ml::DicomManufacturing3DModelModuleTagInterface, ml::DicomImageTypeTagInterface, ml::DicomImagePlaneModuleTagInterface, ml::DicomImageDescriptionTagInterface, ml::DicomGeneralStudyModuleTagInterface, ml::DicomGeneralSeriesModuleTagInterface, ml::DicomGeneralImageModuleTagInterface, ml::DicomGeneralEquipmentModuleTagInterface, ml::DicomFrameOfReferenceModuleTagInterface, ml::DicomEnhancedMRImageModuleTagInterface, ml::DicomEncapsulatedDocumentSeriesModuleTagInterface, ml::DicomEncapsulatedDocumentModuleTagInterface, ml::DicomDeformableSpatialRegistrationModuleTagInterface, ml::DicomCopyTagSetInterface, ml::DicomCopyGroupsTagInterface, ml::DicomContentIdentificationMacroTagInterface, ml::DicomContentDateTimeTagInterface, ml::DicomCommonInstanceReferenceModuleTagInterface, ml::DicomCIDSingleEntryEditTagInterface, ml::DicomCIDEditTagInterface, ml::DicomBoolInheritAndWriteTagInterface, ml::DicomAcquisitionContextModuleTagInterface, ml::DicomModifyTagsVariousFieldAddOns, ml::DicomModifyImageTagsFieldAddOn, ml::DicomModifyFieldAddOnBase, ml::DicomModifyVOILUTModuleFieldAddOn, ml::DicomModifyStructureSetModuleFieldAddOn, ml::DicomModifySOPCommonModuleFieldAddOn, ml::DicomModifyRTTreatmentSummaryRecordModuleFieldAddOn, ml::DicomModifyRTTreatmentMachineRecordModuleFieldAddOn, ml::DicomModifyRTToleranceTablesModuleFieldAddOn, ml::DicomModifyRTSeriesModuleFieldAddOn, ml::DicomModifyRTROIObservationsModuleFieldAddOn, ml::DicomModifyRTPrescriptionModuleFieldAddOn, ml::DicomModifyRTPatientSetupModuleFieldAddOn, ml::DicomModifyRTIonToleranceTablesModuleFieldAddOn, ml::DicomModifyRTIonBeamsSessionRecordModuleFieldAddOn, ml::DicomModifyRTIonBeamsModuleFieldAddOn, ml::DicomModifyRTImageModuleFieldAddOn, ml::DicomModifyRTGeneralTreatmentRecordModuleFieldAddOn, ml::DicomModifyRTGeneralPlanModuleFieldAddOn, ml::DicomModifyRTFractionSchemeModuleFieldAddOn, ml::DicomModifyRTDVHModuleFieldAddOn, ml::DicomModifyRTDoseROIModuleFieldAddOn, ml::DicomModifyRTDoseModuleFieldAddOn, ml::DicomModifyRTBrachyApplicationSetupsModuleFieldAddOn, ml::DicomModifyRTBeamsModuleFieldAddOn, ml::DicomModifyROIContourModuleFieldAddOn, ml::DicomModifyPatientStudyModuleFieldAddOn, ml::DicomModifyPatientModuleFieldAddOn, ml::DicomModifyOverlayPlaneModuleFieldAddOn, ml::DicomModifyMultiFrameOverlayModuleFieldAddOn, ml::DicomModifyMultiFrameModuleFieldAddOn, ml::DicomModifyModalityLUTModuleFieldAddOn, ml::DicomModifyMeasuredDoseReferenceRecordModuleFieldAddOn, ml::DicomModifyImagePlaneModuleFieldAddOn, ml::DicomModifyImagePixelModuleFieldAddOn, ml::DicomModifyGeneralStudyModuleFieldAddOn, ml::DicomModifyGeneralImageModuleFieldAddOn, ml::DicomModifyGeneralEquipmentModuleFieldAddOn, ml::DicomModifyFrameOfReferenceModuleFieldAddOn, ml::DicomModifyDeviceModuleFieldAddOn, ml::DicomModifyContrastBolusModuleFieldAddOn, ml::DicomModifyClinicalTrialSubjectModuleFieldAddOn, ml::DicomModifyClinicalTrialStudyModuleFieldAddOn, ml::DicomModifyClinicalTrialSeriesModuleFieldAddOn, ml::DicomModifyCineModuleFieldAddOn, ml::DicomModifyCalculatedDoseReferenceRecordModuleFieldAddOn, ml::DicomModifyApprovalModuleFieldAddOn, and ml::DicomModifySubTreeSelectorFieldAddOn.
◆ clear()
| void ml::DicomModifyList::clear | ( | ) |
Makes modifier array empty and deletes all of them.
◆ getInputPlugin()
|
inline |
Returns the optional plugin to be called by applyModififcations.
Definition at line 71 of file mlDicomModifyList.h.
◆ getModifierList() [1/2]
|
inline |
Get direct access to internal list to allow callers direct manipulations which, however, must obey the restriction that ownership belongs to *this, i.e.
inserting or deleting must also handle addition and deleting of the DicomModifyBase objects correctly.
Definition at line 61 of file mlDicomModifyList.h.
◆ getModifierList() [2/2]
|
inline |
Same as getModifierList() only for constant access.
Definition at line 64 of file mlDicomModifyList.h.
◆ setInputPlugin()
|
inline |
Sets an optional plugin to be called by applyModififcations or resets it to nullptr; the input is called after the objects in _modfiers list.
Definition at line 68 of file mlDicomModifyList.h.
The documentation for this class was generated from the following file:
- FMEstable/ReleaseMeVis/Projects/DICOM/MLDicomModify/Sources/mlDicomModifyList.h
