MeVisLab Toolbox Reference
ml::DicomModifyOrdinaryFieldAddOn Class Reference

#include <mlDicomModifyOrdinaryFieldAddOn.h>

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

Public Member Functions

 DicomModifyOrdinaryFieldAddOn (FieldContainer &fieldContainerRef, size_t numInstances=1)
 See DicomModifyFieldAddOnBase::DicomModifyFieldAddOnBase(fieldContainerRef, numInstances).
void addFields () override
 Add fields to the FieldContainer.
void handleFieldActivationChanges () override
 Handle class changes according to Module::activateAttachments.
FieldAddOnBase::FieldChangeState handleFieldChanges (Field *field) override
 Handle field notifications according to Module::handleNotification.
Public Member Functions inherited from ml::DicomModifyFieldAddOnBase
 DicomModifyFieldAddOnBase (FieldContainer &fieldContainerRef, size_t numInstances=1, bool createInputModifyTagsPluginBaseConnectorField=false, bool createOutputModifyTagsPluginBaseConnectorField=false)
 ~DicomModifyFieldAddOnBase () override
 Destructor resetting connector fields if they exist.
size_t getNumInstances () const
 Returns the number of instances to be created by derived fields.
std::string applyModifications (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos=nullptr) override
virtual void inheritValues (DCMTree::Const_TreePtr)
 Can be used to implement the copy of tag values from the given dcmTree to the fields.
virtual std::string checkConsistency () const
 Checks for invalid parameters; return textual description on error, or empty string on success.
BaseFieldgetOutputModifierListFld () const
 Provide access to output base field if it was created.
BaseFieldgetInputModifierListFld () const
 Provide access to input base connector field if it was created.
Public Member Functions inherited from ml::DicomModifyList
 DicomModifyList ()
 ~DicomModifyList () override
 Destructor also destroying all of its stored Modifiers.
void addModifier (DicomModifyBase *modifier, bool atEnd=true)
void clear ()
 Makes modifier array empty and deletes all of them.
std::vector< DicomModifyBase * > & getModifierList ()
const std::vector< DicomModifyBase * > & getModifierList () const
 Same as getModifierList() only for constant access.
void setInputPlugin (DicomModifyList *inputPlugin=nullptr)
DicomModifyListgetInputPlugin () const
 Returns the optional plugin to be called by applyModififcations.
Public Member Functions inherited from ml::Base
 Base ()
 Constructor.
virtual ~Base ()
 Destructor.
virtual BasedeepCopy () const
bool isOfAllowedType (const std::vector< const RuntimeType * > &types) const
virtual bool isRefCountedBase () const
 Returns whether the instance is derived from RefCountedBase.
virtual std::string detailString () const
virtual bool implementsPersistence (PersistenceInterface) const
virtual std::string persistentState () const
 Returns a string describing the object's internal state.
virtual void setPersistentState (const std::string &state)
virtual void addStateToTree (TreeNode *) const
 Attaches the object state as children of the given parent node.
virtual void readStateFromTree (TreeNode *)
 Reads the object state from the children of the given parent node.
virtual void writeTo (AbstractPersistenceOutputStream *) const
virtual void readFrom (AbstractPersistenceInputStream *, int)
Public Member Functions inherited from ml::FieldAddOnBase
 FieldAddOnBase (FieldContainer &fieldContainerRef)
 Constructor, setting the reference of the FieldContainer managing the fields.
virtual ~FieldAddOnBase ()
 Destructor.
FieldContainergetFieldContainer ()
 Returns the referenced container.
const FieldContainergetFieldContainer () const
 Returns the referenced container.
std::vector< Field * > & getFields ()
 Return modification access to the list of managed fields, use at own risk!
const std::vector< Field * > & getFields () const
 Return constant access to the list of managed fields!
virtual FieldChangeState getMergedFieldChangeState (FieldChangeState state1, FieldChangeState state2) const
 Returns a FieldChangeState which best represents a merge of the two given states.
virtual bool hasField (Field *field) const
 Returns true if the passed fieldPtr is in _fieldPointers, otherwise false.

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.
Protected Member Functions inherited from ml::FieldAddOnBase
void _addFieldPointer (Field *field)

Detailed Description

FieldAddOn class managing fields to represent functionality from DicomModifyOrdinary to modify ordinary DICOM tags.

Definition at line 24 of file mlDicomModifyOrdinaryFieldAddOn.h.

Constructor & Destructor Documentation

◆ DicomModifyOrdinaryFieldAddOn()

ml::DicomModifyOrdinaryFieldAddOn::DicomModifyOrdinaryFieldAddOn ( FieldContainer & fieldContainerRef,
size_t numInstances = 1 )
inline

See DicomModifyFieldAddOnBase::DicomModifyFieldAddOnBase(fieldContainerRef, numInstances).

Definition at line 28 of file mlDicomModifyOrdinaryFieldAddOn.h.

References ml::DicomModifyFieldAddOnBase::DicomModifyFieldAddOnBase().

Referenced by handleFieldChanges().

Member Function Documentation

◆ addFields()

void ml::DicomModifyOrdinaryFieldAddOn::addFields ( )
overridevirtual

Add fields to the FieldContainer.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ handleFieldActivationChanges()

void ml::DicomModifyOrdinaryFieldAddOn::handleFieldActivationChanges ( )
overridevirtual

Handle class changes according to Module::activateAttachments.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ handleFieldChanges()

FieldAddOnBase::FieldChangeState ml::DicomModifyOrdinaryFieldAddOn::handleFieldChanges ( Field * field)
overridevirtual

Handle field notifications according to Module::handleNotification.

Reimplemented from ml::DicomModifyFieldAddOnBase.

References DicomModifyOrdinaryFieldAddOn().


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