MeVisLab Toolbox Reference
ml::DicomModifyFieldAddOnBase Class Reference

The class DicomModifyFieldAddOnBase is dedicated to manage fields for ML modules and instances derived from DicomModifyBase to combine field handling and tag modification functionality to modify DCMTree's and to allow concatenation of them to pipelines. More...

#include <mlDicomModifyFieldAddOnBase.h>

Inheritance diagram for ml::DicomModifyFieldAddOnBase:
ml::DicomModifyList ml::FieldAddOnBase ml::Base ml::DicomAcquisitionContextModuleTagInterface ml::DicomBoolInheritAndWriteTagInterface ml::DicomCIDEditTagInterface ml::DicomCIDSingleEntryEditTagInterface ml::DicomCommonInstanceReferenceModuleTagInterface ml::DicomContentDateTimeTagInterface ml::DicomContentIdentificationMacroTagInterface ml::DicomCopyGroupsTagInterface ml::DicomCopyTagSetInterface ml::DicomDeformableSpatialRegistrationModuleTagInterface ml::DicomEncapsulatedDocumentModuleTagInterface ml::DicomEncapsulatedDocumentSeriesModuleTagInterface ml::DicomEnhancedMRImageModuleTagInterface ml::DicomFrameOfReferenceModuleTagInterface ml::DicomGeneralEquipmentModuleTagInterface ml::DicomGeneralImageModuleTagInterface ml::DicomGeneralSeriesModuleTagInterface ml::DicomGeneralStudyModuleTagInterface ml::DicomImageDescriptionTagInterface ml::DicomImagePlaneModuleTagInterface ml::DicomImageTypeTagInterface ml::DicomMRSeriesModuleTagInterface ml::DicomManufacturing3DModelModuleTagInterface ml::DicomModifyImageTagsFieldAddOn ml::DicomModifyModuleFieldAddOnBase ml::DicomModifyOrdinaryFieldAddOn ml::DicomModifyOtherTagOperationsFieldAddOn ml::DicomModifyPrivateAddFieldAddOn ml::DicomModifyPrivateRemoveFieldAddOn ml::DicomModifySequenceFieldAddOn ml::DicomModifySubTreeSelectorFieldAddOn ml::DicomModifyTagsVariousFieldAddOns ml::DicomPatientModuleTagInterface ml::DicomReferencedImageSequenceTagInterface ml::DicomSCEquipmentModuleTagInterface ml::DicomSCMultiframeImageModuleTagInterface ml::DicomSOPCommonModuleTagInterface ml::DicomSOPInstanceReferenceMacroTagInterface ml::DicomSegmentSequenceTagInterface ml::DicomSegmentationImageModuleTagInterface ml::DicomSegmentationSeriesModuleAttributesTagInterface ml::DicomSeriesAndInstanceReferenceMacroTagInterface ml::DicomSpatialFiducialsModuleTagInterface ml::DicomValueComboBoxSelectorTagInterface ml::DicomValueInheritAndCreateTagInterface

Public Member Functions

 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...
 
std::string applyModifications (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos=nullptr) override
 Applies first the changes to the dcmTree as described in DicomModifyList::applyModifications() and then calls applyModifications() on all connected input DicomModifyList objects. More...
 
void addFields () override
 Add fields to field container of the FieldAddOn. More...
 
void handleFieldActivationChanges () override
 Handle class changes according to Module::activateAttachments. More...
 
FieldAddOnBase::FieldChangeState handleFieldChanges (Field *field) override
 Handle field notifications according to Module::handleNotification with a return of field change state. More...
 
virtual void inheritValues (DCMTree::Const_TreePtr)
 Can be used to implement the copy of tag values from the given dcmTree to the fields. More...
 
virtual std::string checkConsistency () const
 Checks for invalid parameters; return textual description on error, or empty string on success. More...
 
BaseFieldgetOutputModifierListFld () const
 Provide access to output base field if it was created. More...
 
BaseFieldgetInputModifierListFld () 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...
 
DicomModifyListgetInputPlugin () 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 BasedeepCopy () 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...
 
FieldContainergetFieldContainer ()
 Returns the referenced container. More...
 
const FieldContainergetFieldContainer () 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 Member Functions

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...
 

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...
 
- 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

The class DicomModifyFieldAddOnBase is dedicated to manage fields for ML modules and instances derived from DicomModifyBase to combine field handling and tag modification functionality to modify DCMTree's and to allow concatenation of them to pipelines.


Definition at line 29 of file mlDicomModifyFieldAddOnBase.h.

Constructor & Destructor Documentation

◆ DicomModifyFieldAddOnBase()

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.

Parameters
fieldContainerRefthe modifiable reference of the FieldContainer which shall be extended by this instance.
numInstancesthe number of entries to be created.
createInputModifyTagsPluginBaseConnectorFieldadds a Base input connector to the field container which which allows the connection of further DicomModifyList objects to be called from applyModifications().
createOutputModifyTagsPluginBaseConnectorFieldwill add a Base output connector to the field container which
allows the connection of this to other DicomModifyList objects.

◆ ~DicomModifyFieldAddOnBase()

ml::DicomModifyFieldAddOnBase::~DicomModifyFieldAddOnBase ( )
override

Destructor resetting connector fields if they exist.

Member Function Documentation

◆ addFields()

void ml::DicomModifyFieldAddOnBase::addFields ( )
overridevirtual

Add fields to field container of the FieldAddOn.

Implements ml::FieldAddOnBase.

Reimplemented in ml::DicomModifyModuleFieldAddOnBase, 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, 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::DicomModifySubTreeSelectorFieldAddOn, ml::DicomModifySequenceFieldAddOn, ml::DicomModifyPrivateRemoveFieldAddOn, ml::DicomModifyPrivateAddFieldAddOn, ml::DicomModifyOtherTagOperationsFieldAddOn, ml::DicomModifyOrdinaryFieldAddOn, and ml::DicomModifyImageTagsFieldAddOn.

◆ applyModifications()

std::string ml::DicomModifyFieldAddOnBase::applyModifications ( DCMTree::TreePtr  dcmTree,
const FieldContainer treeInfos = nullptr 
)
overridevirtual

Applies first the changes to the dcmTree as described in DicomModifyList::applyModifications() and then calls applyModifications() on all connected input DicomModifyList objects.

Parameters
dcmTreeThe DICOM tree to be modified.
treeInfosA FieldContainer which - if not nullptr - can contain additional user defined information fields about dcmTree and the changes to perform.
Returns
An empty string on success, otherwise a cumulative descriptive string of all problems.

Reimplemented from ml::DicomModifyList.

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::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.

◆ checkConsistency()

virtual std::string ml::DicomModifyFieldAddOnBase::checkConsistency ( ) const
inlinevirtual

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

Reimplemented in 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, ml::DicomValueInheritAndCreateTagInterface, 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::DicomCopyGroupsTagInterface, ml::DicomContentIdentificationMacroTagInterface, ml::DicomContentDateTimeTagInterface, ml::DicomCommonInstanceReferenceModuleTagInterface, ml::DicomCIDSingleEntryEditTagInterface, ml::DicomCIDEditTagInterface, ml::DicomBoolInheritAndWriteTagInterface, and ml::DicomAcquisitionContextModuleTagInterface.

Definition at line 79 of file mlDicomModifyFieldAddOnBase.h.

◆ getInputModifierListFld()

BaseField* ml::DicomModifyFieldAddOnBase::getInputModifierListFld ( ) const
inline

Provide access to input base connector field if it was created.

Definition at line 85 of file mlDicomModifyFieldAddOnBase.h.

◆ getNumInstances()

size_t ml::DicomModifyFieldAddOnBase::getNumInstances ( ) const
inline

Returns the number of instances to be created by derived fields.

Definition at line 55 of file mlDicomModifyFieldAddOnBase.h.

◆ getOutputModifierListFld()

BaseField* ml::DicomModifyFieldAddOnBase::getOutputModifierListFld ( ) const
inline

Provide access to output base field if it was created.

Definition at line 82 of file mlDicomModifyFieldAddOnBase.h.

◆ handleFieldActivationChanges()

◆ handleFieldChanges()

FieldAddOnBase::FieldChangeState ml::DicomModifyFieldAddOnBase::handleFieldChanges ( Field field)
overridevirtual

◆ inheritValues()

virtual void ml::DicomModifyFieldAddOnBase::inheritValues ( DCMTree::Const_TreePtr  )
inlinevirtual

Can be used to implement the copy of tag values from the given dcmTree to the fields.

Reimplemented in 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, ml::DicomValueInheritAndCreateTagInterface, 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, and ml::DicomAcquisitionContextModuleTagInterface.

Definition at line 76 of file mlDicomModifyFieldAddOnBase.h.

◆ isIn()

static bool ml::DicomModifyFieldAddOnBase::isIn ( const std::string &  str,
const char *const *  values,
size_t  numValues 
)
static

Static helper function which checks whether str is part of the given list of values which has numValues entries.


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