MeVisLab Toolbox Reference
ml::DicomPatientModuleTagInterface Class Reference

Manages the module field interface according to DICOM Patient Module, C.7.1.1. More...

#include <mlDicomPatientModuleTagInterface.h>

Inheritance diagram for ml::DicomPatientModuleTagInterface:
ml::DicomModifyFieldAddOnBase ml::DicomModifyList ml::FieldAddOnBase ml::Base

Public Member Functions

 DicomPatientModuleTagInterface (Module &modRef)
 Constructor, setting the reference of the module for which the fields shall be managed. 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 documentation. More...
 
FieldAddOnBase::FieldChangeState handleFieldChanges (Field *field) override
 Handle field notifications. More...
 
std::string checkConsistency () const override
 Checks for invalid parameters; return textual description on error, or empty string on success. 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...
 
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...
 

Public Attributes

StringField_patientsNameFld
 Fields. More...
 
StringField_patientIDFld
 String/number used to identify the patient. More...
 
EnumField_patientBirthDateYearEnumFld
 The year in which the patient was born as enumerator. More...
 
StringField_patientBirthDateYearStringFld
 The year in which the patient was born as string. More...
 
EnumField_patientBirthDateMonthEnumFld
 The month in which the patient was born as enumerator. More...
 
StringField_patientBirthDateMonthStringFld
 The month in which the patient was born as string. More...
 
EnumField_patientBirthDateDayEnumFld
 The day of month in which the patient was born as enumerator. More...
 
StringField_patientBirthDateDayStringFld
 The day of month in which the patient was born as string. More...
 
EnumField_patientSexEnumFld
 The sex of the patient selectable as enumerator. More...
 
StringField_patientSexStringFld
 The final sex string of the patient. More...
 
DicomCopyTagSetInterface _otherPatientRelationshipTags
 All other Patient Relationship tags not available in the interface. More...
 
DicomCopyTagSetInterface _otherPatientIdentificationTags
 All other Patient Identification tags not available in the interface. More...
 
DicomCopyTagSetInterface _otherPatientDemographicTags
 All other Patient Demographic tags not available in the interface. More...
 
DicomCopyTagSetInterface _otherPatientMedicalTags
 All other Patient Medical tags not available in the interface. 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

Manages the module field interface according to DICOM Patient Module, C.7.1.1.

Definition at line 22 of file mlDicomPatientModuleTagInterface.h.

Constructor & Destructor Documentation

◆ DicomPatientModuleTagInterface()

ml::DicomPatientModuleTagInterface::DicomPatientModuleTagInterface ( Module modRef)

Constructor, setting the reference of the module for which the fields shall be managed.

Member Function Documentation

◆ addFields()

void ml::DicomPatientModuleTagInterface::addFields ( )
overridevirtual

Add fields to field container of module.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ applyModifications()

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

◆ checkConsistency()

std::string ml::DicomPatientModuleTagInterface::checkConsistency ( ) const
overridevirtual

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

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ handleFieldChanges()

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

Handle field notifications.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ inheritValues()

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

◆ _otherPatientDemographicTags

DicomCopyTagSetInterface ml::DicomPatientModuleTagInterface::_otherPatientDemographicTags

All other Patient Demographic tags not available in the interface.

Definition at line 75 of file mlDicomPatientModuleTagInterface.h.

◆ _otherPatientIdentificationTags

DicomCopyTagSetInterface ml::DicomPatientModuleTagInterface::_otherPatientIdentificationTags

All other Patient Identification tags not available in the interface.

Definition at line 73 of file mlDicomPatientModuleTagInterface.h.

◆ _otherPatientMedicalTags

DicomCopyTagSetInterface ml::DicomPatientModuleTagInterface::_otherPatientMedicalTags

All other Patient Medical tags not available in the interface.

Definition at line 77 of file mlDicomPatientModuleTagInterface.h.

◆ _otherPatientRelationshipTags

DicomCopyTagSetInterface ml::DicomPatientModuleTagInterface::_otherPatientRelationshipTags

All other Patient Relationship tags not available in the interface.

Definition at line 71 of file mlDicomPatientModuleTagInterface.h.

◆ _patientBirthDateDayEnumFld

EnumField* ml::DicomPatientModuleTagInterface::_patientBirthDateDayEnumFld

The day of month in which the patient was born as enumerator.

Definition at line 61 of file mlDicomPatientModuleTagInterface.h.

◆ _patientBirthDateDayStringFld

StringField* ml::DicomPatientModuleTagInterface::_patientBirthDateDayStringFld

The day of month in which the patient was born as string.

Definition at line 63 of file mlDicomPatientModuleTagInterface.h.

◆ _patientBirthDateMonthEnumFld

EnumField* ml::DicomPatientModuleTagInterface::_patientBirthDateMonthEnumFld

The month in which the patient was born as enumerator.

Definition at line 56 of file mlDicomPatientModuleTagInterface.h.

◆ _patientBirthDateMonthStringFld

StringField* ml::DicomPatientModuleTagInterface::_patientBirthDateMonthStringFld

The month in which the patient was born as string.

Definition at line 58 of file mlDicomPatientModuleTagInterface.h.

◆ _patientBirthDateYearEnumFld

EnumField* ml::DicomPatientModuleTagInterface::_patientBirthDateYearEnumFld

The year in which the patient was born as enumerator.

Definition at line 51 of file mlDicomPatientModuleTagInterface.h.

◆ _patientBirthDateYearStringFld

StringField* ml::DicomPatientModuleTagInterface::_patientBirthDateYearStringFld

The year in which the patient was born as string.

Definition at line 53 of file mlDicomPatientModuleTagInterface.h.

◆ _patientIDFld

StringField* ml::DicomPatientModuleTagInterface::_patientIDFld

String/number used to identify the patient.

Definition at line 48 of file mlDicomPatientModuleTagInterface.h.

◆ _patientSexEnumFld

EnumField* ml::DicomPatientModuleTagInterface::_patientSexEnumFld

The sex of the patient selectable as enumerator.

Definition at line 66 of file mlDicomPatientModuleTagInterface.h.

◆ _patientSexStringFld

StringField* ml::DicomPatientModuleTagInterface::_patientSexStringFld

The final sex string of the patient.

Definition at line 68 of file mlDicomPatientModuleTagInterface.h.

◆ _patientsNameFld

StringField* ml::DicomPatientModuleTagInterface::_patientsNameFld

Fields.

The name of the patient this report is created for.

Definition at line 46 of file mlDicomPatientModuleTagInterface.h.


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