Class managing a list of BASE_FIELD_ADD_ON_TYPE to simplify usage of multiple AddOns; AddOns are never owned by DicomModifyFieldAddOnList instances, this the life time of the AddOns must be longer than the usage of DicomModifyFieldAddOnList instances. More...
#include <mlDicomModifyFieldAddOnList.h>
Public Types | |
| typedef FieldAddOnList< BASE_FIELD_ADD_ON_TYPE, PIMPL_OBJ_TYPE > | SuperList |
| Type of inherited SuperClass base class. More... | |
| typedef BASE_FIELD_ADD_ON_TYPE | SuperBase |
| Type of inherited SuperClass base class. More... | |
 Public Types inherited from ml::FieldAddOnList< BASE_FIELD_ADD_ON_TYPE, void * > | |
| typedef std::vector< BASE_FIELD_ADD_ON_TYPE * > | FieldAddOnContainer |
| The internally used container to manage the FieldAddOns. More... | |
Public Member Functions | |
| DicomModifyFieldAddOnList (FieldContainer &fieldContainerRef) | |
| Constructor, setting the reference of the FieldContainer managing the fields. More... | |
| std::string | applyModifications (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos=nullptr) override |
| Add functionality of additional methods of DicomModifyFieldAddOnBase; addFields(), handleFieldActivationChanges(), and handleFieldChanges(Field *field) is already implemented in FieldAddOnList base class. More... | |
| void | inheritValues (DCMTree::Const_TreePtr dcmTree) override |
| Applies DicomModifyFieldAddOnBase::inheritValues for each instance. More... | |
| std::string | checkConsistency () const override |
| Applies DicomModifyFieldAddOnBase::checkConsistency to each instance, and returns the concatenation of all return values. More... | |
| Public Member Functions inherited from ml::FieldAddOnList< BASE_FIELD_ADD_ON_TYPE, void * > | |
| FieldAddOnList (FieldContainer &fieldContainerRef) | |
| Constructor, setting the reference of the FieldContainer managing the fields. More... | |
| ~FieldAddOnList () override | |
| Destructor. More... | |
| FieldAddOnContainer & | getFieldAddOns () |
| Returns the referenced container. More... | |
| const FieldAddOnContainer & | getFieldAddOns () const |
| Returns the constant referenced container. More... | |
| virtual void | registerFieldAddOn (BASE_FIELD_ADD_ON_TYPE *fieldAddOn) |
| Register a FieldAddOn in *this; nullptr fieldAddOn pointers are ignored and not added. More... | |
| virtual bool | hasFieldAddOn (BASE_FIELD_ADD_ON_TYPE *fieldAddOn) const |
| Returns true if the passed fieldPtr is in _fieldPointers, otherwise false. More... | |
| void | addFields () override |
| Add fields to field container of module. More... | |
| void | handleFieldActivationChanges () override |
| Handle class changes according to Module::activateAttachments. More... | |
| FieldAddOnBase::FieldChangeState | handleFieldChanges (Field *field) override |
| Handle field notifications according to Module::handleNotification functionality. More... | |
Additional Inherited Members | |
| Public Attributes inherited from ml::FieldAddOnList< BASE_FIELD_ADD_ON_TYPE, void * > | |
| void * | _pImpl |
| User defined object not used in this base class (only default constructor is called), it is useful for private implementations. More... | |
Detailed Description
template<typename BASE_FIELD_ADD_ON_TYPE, typename PIMPL_OBJ_TYPE = void*>
class ml::DicomModifyFieldAddOnList< BASE_FIELD_ADD_ON_TYPE, PIMPL_OBJ_TYPE >
Class managing a list of BASE_FIELD_ADD_ON_TYPE to simplify usage of multiple AddOns; AddOns are never owned by DicomModifyFieldAddOnList instances, this the life time of the AddOns must be longer than the usage of DicomModifyFieldAddOnList instances.
It is implemented as template allowing to derive from differently typed DicomModifyFieldAddOn classes and it also allows the usage of a private implementation pointer which allows to hide collections of DicomModifyFieldAddOnList inside the list implementations without needing to make them public. BASE_FIELD_ADD_ON_TYPE is expected to fulfil the behaviour of at least DicomModifyFieldAddOnBase.
Definition at line 31 of file mlDicomModifyFieldAddOnList.h.
Member Typedef Documentation
◆ SuperBase
| typedef BASE_FIELD_ADD_ON_TYPE ml::DicomModifyFieldAddOnList< BASE_FIELD_ADD_ON_TYPE, PIMPL_OBJ_TYPE >::SuperBase |
Type of inherited SuperClass base class.
Definition at line 39 of file mlDicomModifyFieldAddOnList.h.
◆ SuperList
| typedef FieldAddOnList<BASE_FIELD_ADD_ON_TYPE, PIMPL_OBJ_TYPE> ml::DicomModifyFieldAddOnList< BASE_FIELD_ADD_ON_TYPE, PIMPL_OBJ_TYPE >::SuperList |
Type of inherited SuperClass base class.
Definition at line 36 of file mlDicomModifyFieldAddOnList.h.
Constructor & Destructor Documentation
◆ DicomModifyFieldAddOnList()
|
inline |
Constructor, setting the reference of the FieldContainer managing the fields.
Definition at line 42 of file mlDicomModifyFieldAddOnList.h.
Member Function Documentation
◆ applyModifications()
|
inlineoverride |
Add functionality of additional methods of DicomModifyFieldAddOnBase; addFields(), handleFieldActivationChanges(), and handleFieldChanges(Field *field) is already implemented in FieldAddOnList base class.
Applies DicomModifyFieldAddOnBase::applyModifications for each instance, and returns the concatenation of all return values.
Definition at line 51 of file mlDicomModifyFieldAddOnList.h.
◆ checkConsistency()
|
inlineoverride |
Applies DicomModifyFieldAddOnBase::checkConsistency to each instance, and returns the concatenation of all return values.
Definition at line 71 of file mlDicomModifyFieldAddOnList.h.
◆ inheritValues()
|
inlineoverride |
Applies DicomModifyFieldAddOnBase::inheritValues for each instance.
Definition at line 63 of file mlDicomModifyFieldAddOnList.h.
The documentation for this class was generated from the following file:
- FMEstable/ReleaseMeVis/Projects/DICOM/MLDicomModify/Sources/mlDicomModifyFieldAddOnList.h
