MeVisLab Toolbox Reference
ml::FieldAddOnBase Class Referenceabstract

Abstract base class for field interfaces to be added to other ML module classes. More...

#include <mlFieldAddOnBase.h>

Inheritance diagram for ml::FieldAddOnBase:
ml::DicomModifyFieldAddOnBase ml::DicomTagDumpFieldAddOn ml::RelatedDicomVolumeFieldAddOn ml::StringLineFilterFieldAddOn ml::TreeAndVolumeInputFieldAddOn 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 Types

enum  FieldChangeState { NoChange = 0 , StatusOnlyChange , RecalculationRequired }
 Describes the type of a field changes detected in handleFieldChanges(Field *field). More...
 

Public Member Functions

 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 void addFields ()=0
 Add fields to field container of module. More...
 
virtual void handleFieldActivationChanges ()
 Handle class changes according to Module::activateAttachments. More...
 
virtual FieldChangeState handleFieldChanges (Field *field)
 Handle field notifications according to Module::handleNotification functionality. 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 Member Functions

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

Abstract base class for field interfaces to be added to other ML module classes.

Definition at line 22 of file mlFieldAddOnBase.h.

Member Enumeration Documentation

◆ FieldChangeState

Describes the type of a field changes detected in handleFieldChanges(Field *field).

Enumerator
NoChange 

No change took place.

StatusOnlyChange 

Display-only or status fields have been changed which do not require recalculations for example of image outputs.

RecalculationRequired 

A field was changes which requires recalculations or (image) output updates.

Definition at line 26 of file mlFieldAddOnBase.h.

Constructor & Destructor Documentation

◆ FieldAddOnBase()

ml::FieldAddOnBase::FieldAddOnBase ( FieldContainer fieldContainerRef)
inline

Constructor, setting the reference of the FieldContainer managing the fields.

Definition at line 35 of file mlFieldAddOnBase.h.

◆ ~FieldAddOnBase()

virtual ml::FieldAddOnBase::~FieldAddOnBase ( )
inlinevirtual

Destructor.

Definition at line 40 of file mlFieldAddOnBase.h.

Member Function Documentation

◆ _addFieldPointer()

void ml::FieldAddOnBase::_addFieldPointer ( Field field)
protected

Helper routine to add a Field pointer to _fieldPointers, empty pointers and pointers added more than once will be handled fatally.

◆ addFields()

virtual void ml::FieldAddOnBase::addFields ( )
pure virtual

Add fields to field container of module.

All derived versions must add their fields to getFieldContainer() and with _addFieldPointer().

Implemented 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::RelatedDicomVolumeFieldAddOn, ml::DicomTagDumpFieldAddOn, 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::TreeAndVolumeInputFieldAddOn, ml::DicomModifyTagsVariousFieldAddOns, ml::DicomModifySubTreeSelectorFieldAddOn, ml::DicomModifySequenceFieldAddOn, ml::DicomModifyPrivateRemoveFieldAddOn, ml::DicomModifyPrivateAddFieldAddOn, ml::DicomModifyOtherTagOperationsFieldAddOn, ml::DicomModifyOrdinaryFieldAddOn, ml::DicomModifyImageTagsFieldAddOn, ml::DicomModifyFieldAddOnBase, and ml::StringLineFilterFieldAddOn.

◆ getFieldContainer() [1/2]

FieldContainer& ml::FieldAddOnBase::getFieldContainer ( )
inline

Returns the referenced container.

Definition at line 43 of file mlFieldAddOnBase.h.

◆ getFieldContainer() [2/2]

const FieldContainer& ml::FieldAddOnBase::getFieldContainer ( ) const
inline

Returns the referenced container.

Definition at line 46 of file mlFieldAddOnBase.h.

◆ getFields() [1/2]

std::vector<Field*>& ml::FieldAddOnBase::getFields ( )
inline

Return modification access to the list of managed fields, use at own risk!

Definition at line 49 of file mlFieldAddOnBase.h.

◆ getFields() [2/2]

const std::vector<Field*>& ml::FieldAddOnBase::getFields ( ) const
inline

Return constant access to the list of managed fields!

Definition at line 52 of file mlFieldAddOnBase.h.

◆ getMergedFieldChangeState()

virtual FieldChangeState ml::FieldAddOnBase::getMergedFieldChangeState ( FieldChangeState  state1,
FieldChangeState  state2 
) const
inlinevirtual

Returns a FieldChangeState which best represents a merge of the two given states.

Definition at line 71 of file mlFieldAddOnBase.h.

References ml::DicomToMLTools::NoChange.

◆ handleFieldActivationChanges()

◆ handleFieldChanges()

virtual FieldChangeState ml::FieldAddOnBase::handleFieldChanges ( Field field)
inlinevirtual

Handle field notifications according to Module::handleNotification functionality.

The default functionality return

Parameters
fieldThe field whose was changed.
Returns
RecalculationRequired if the field is found in _fieldPointer, otherwise NoChange.

Reimplemented in ml::DicomModifyModuleFieldAddOnBase, ml::RelatedDicomVolumeFieldAddOn, ml::DicomTagDumpFieldAddOn, ml::DicomValueInheritAndCreateTagInterface, ml::DicomValueComboBoxSelectorTagInterface, ml::DicomSOPCommonModuleTagInterface, ml::DicomSeriesAndInstanceReferenceMacroTagInterface, ml::DicomSegmentSequenceTagInterface, ml::DicomSegmentationImageModuleTagInterface, ml::DicomReferencedImageSequenceTagInterface, ml::DicomPatientModuleTagInterface, ml::DicomManufacturing3DModelModuleTagInterface, ml::DicomImageTypeTagInterface, ml::DicomImageDescriptionTagInterface, ml::DicomGeneralStudyModuleTagInterface, ml::DicomGeneralSeriesModuleTagInterface, ml::DicomGeneralEquipmentModuleTagInterface, ml::DicomEnhancedMRImageModuleTagInterface, ml::DicomEncapsulatedDocumentSeriesModuleTagInterface, ml::DicomCopyTagSetInterface, ml::DicomCopyGroupsTagInterface, ml::DicomCommonInstanceReferenceModuleTagInterface, ml::DicomCIDSingleEntryEditTagInterface, ml::DicomCIDEditTagInterface, ml::DicomBoolInheritAndWriteTagInterface, ml::DicomAcquisitionContextModuleTagInterface, ml::TreeAndVolumeInputFieldAddOn, ml::DicomModifyTagsVariousFieldAddOns, ml::DicomModifySubTreeSelectorFieldAddOn, ml::DicomModifySequenceFieldAddOn, ml::DicomModifyPrivateRemoveFieldAddOn, ml::DicomModifyPrivateAddFieldAddOn, ml::DicomModifyOtherTagOperationsFieldAddOn, ml::DicomModifyOrdinaryFieldAddOn, ml::DicomModifyFieldAddOnBase, and ml::StringLineFilterFieldAddOn.

Definition at line 65 of file mlFieldAddOnBase.h.

References ml::DicomToMLTools::NoChange.

◆ hasField()

virtual bool ml::FieldAddOnBase::hasField ( Field field) const
virtual

Returns true if the passed fieldPtr is in _fieldPointers, otherwise false.


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