MeVisLab Toolbox Reference
ml::DicomModifyDeviceModuleFieldAddOn Class Reference

#include <mlDicomModifyDeviceModuleFieldAddOn.h>

Inheritance diagram for ml::DicomModifyDeviceModuleFieldAddOn:
ml::DicomModifyModuleFieldAddOnBase ml::DicomModifyFieldAddOnBase ml::DicomModifyList ml::FieldAddOnBase ml::Base

Public Member Functions

 DicomModifyDeviceModuleFieldAddOn (FieldContainer &fieldContainer, bool createInputModifyTagsPluginBaseConnectorField=false, bool createOutputModifyTagsPluginBaseConnectorField=false)
void addFields () override
 Add fields to field container of the FieldAddOn.
virtual std::string applyModifications (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos=NULL) override
void inheritValues (DCMTree::Const_TreePtr dcmTree) override
 Can be used to implement the copy of tag values from the given dcmTree to the fields.
std::string checkConsistency () const override
 Checks for invalid parameters; return textual description on error, or empty string on success.
Public Member Functions inherited from ml::DicomModifyModuleFieldAddOnBase
 DicomModifyModuleFieldAddOnBase (FieldContainer &fieldContainer, const std::string &dicomModuleName, bool createInputModifyTagsPluginBaseConnectorField=false, bool createOutputModifyTagsPluginBaseConnectorField=false)
void setInputDicomTreeField (BaseField *field)
virtual FieldAddOnBase::FieldChangeState handleFieldChanges (Field *field) override
 Handle field notifications according to Module::handleNotification with a return of field change state.
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
void handleFieldActivationChanges () override
 Handle class changes according to Module::activateAttachments.
BaseField * getOutputModifierListFld () const
 Provide access to output base field if it was created.
BaseField * getInputModifierListFld () 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)
DicomModifyList * getInputPlugin () const
 Returns the optional plugin to be called by applyModififcations.
Public Member Functions inherited from ml::Base
 Base ()
 Constructor.
virtual ~Base ()
 Destructor.
virtual Base * deepCopy () 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.
FieldContainer & getFieldContainer ()
 Returns the referenced container.
const FieldContainer & getFieldContainer () 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::DicomModifyModuleFieldAddOnBase
void _addFieldPointer (Field *field)
Protected Member Functions inherited from ml::FieldAddOnBase
void _addFieldPointer (Field *field)
Protected Attributes inherited from ml::DicomModifyModuleFieldAddOnBase
DCMTree::Const_TreePtr _inputDicomTree

Detailed Description

Definition at line 30 of file mlDicomModifyDeviceModuleFieldAddOn.h.

Constructor & Destructor Documentation

◆ DicomModifyDeviceModuleFieldAddOn()

ml::DicomModifyDeviceModuleFieldAddOn::DicomModifyDeviceModuleFieldAddOn ( FieldContainer & fieldContainer,
bool createInputModifyTagsPluginBaseConnectorField = false,
bool createOutputModifyTagsPluginBaseConnectorField = false )

Referenced by checkConsistency().

Member Function Documentation

◆ addFields()

void ml::DicomModifyDeviceModuleFieldAddOn::addFields ( )
overridevirtual

Add fields to field container of the FieldAddOn.

Reimplemented from ml::DicomModifyModuleFieldAddOnBase.

◆ applyModifications()

virtual std::string ml::DicomModifyDeviceModuleFieldAddOn::applyModifications ( DCMTree::TreePtr dcmTree,
const FieldContainer * treeInfos = NULL )
overridevirtual

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
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 be done.
Returns
An empty string on success, otherwise a cumulative descriptive string of all problems.

Reimplemented from ml::DicomModifyList.

◆ checkConsistency()

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

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

Reimplemented from ml::DicomModifyFieldAddOnBase.

References DicomModifyDeviceModuleFieldAddOn().

◆ inheritValues()

void ml::DicomModifyDeviceModuleFieldAddOn::inheritValues ( DCMTree::Const_TreePtr )
overridevirtual

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

Reimplemented from ml::DicomModifyFieldAddOnBase.

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