ml::DicomModifyOrdinaryFieldAddOn Class Reference
FieldAddOn class managing fields to represent functionality from DicomModifyOrdinary to modify ordinary DICOM tags. More...
#include <mlDicomModifyOrdinaryFieldAddOn.h>
Inheritance diagram for ml::DicomModifyOrdinaryFieldAddOn:
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) | |
| 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. | |
| ~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 |
| Applies first the changes to the dcmTree as described in DicomModifyList::applyModifications() and then calls applyModifications() on all connected input DicomModifyList objects. | |
| 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. | |
| 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 () | |
| Constructor creating an empty list of tag modifiers and setting the optional input plugin with a concatenated DicomModifyList. | |
| ~DicomModifyList () override | |
| Destructor also destroying all of its stored Modifiers. | |
| void | addModifier (DicomModifyBase *modifier, bool atEnd=true) |
| Add an object derived from DicomModifyBase which then will be owned (and on destruction deleted) by this. | |
| void | clear () |
| Makes modifier array empty and deletes all of them. | |
| 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. | |
| const std::vector< DicomModifyBase * > & | getModifierList () const |
| Same as getModifierList() only for constant access. | |
| 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. | |
| 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 |
| Set addStateToTree version number that can be accessed via getAddStateVersion() | |
| 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. | |
| virtual bool | isRefCountedBase () const |
| Returns if the instance is derived from RefCountedBase. | |
| virtual std::string | detailString () const |
| Return a string describing this object. | |
| virtual bool | implementsPersistence (PersistenceInterface) const |
| Override this method to declare which persistence interfaces are implemented by your derived class. | |
| virtual std::string | persistentState () const |
| Returns a string describing the object's internal state. | |
| virtual void | setPersistentState (const std::string &state) |
Restores the object's internal state from a string that had been previously generated using persistentState(). | |
| 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 |
| Write the objects state to the data stream object. | |
| virtual void | readFrom (AbstractPersistenceInputStream *, int) |
| Read the objects state from the data stream object. | |
| 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::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. | |
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()
|
inline |
See DicomModifyFieldAddOnBase::DicomModifyFieldAddOnBase(fieldContainerRef, numInstances).
Definition at line 28 of file mlDicomModifyOrdinaryFieldAddOn.h.
Member Function Documentation
◆ addFields()
|
overridevirtual |
Add fields to the FieldContainer.
Reimplemented from ml::DicomModifyFieldAddOnBase.
◆ handleFieldActivationChanges()
|
overridevirtual |
Handle class changes according to Module::activateAttachments.
Reimplemented from ml::DicomModifyFieldAddOnBase.
◆ handleFieldChanges()
|
overridevirtual |
Handle field notifications according to Module::handleNotification.
Reimplemented from ml::DicomModifyFieldAddOnBase.
The documentation for this class was generated from the following file:
- FMEstable/ReleaseMeVis/Projects/DICOM/MLDicomModify/Sources/mlDicomModifyOrdinaryFieldAddOn.h
