ml::DicomSCEquipmentModuleTagInterface Class Reference
Manages the module field interface according to DICOM SC Equipment Module, C.8.8.1.
More...
#include <mlDicomSCEquipmentModuleTagInterface.h>
Inheritance diagram for ml::DicomSCEquipmentModuleTagInterface:
Public Member Functions | |
| DicomSCEquipmentModuleTagInterface (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... | |
| std::string | checkConsistency () const override |
| Checks for invalid parameters; return textual description on error, or empty string on success. More... | |
| bool | isDigitizedFilmConversionType () const |
| Returns true if conversion type is DigitizedFilm, otherwise false. More... | |
| bool | isWorkstationConversionType () const |
| Returns true if conversion type is Workstation (WSD) type, otherwise false. 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... | |
| FieldAddOnBase::FieldChangeState | handleFieldChanges (Field *field) override |
| Handle field notifications according to Module::handleNotification with a return of field change state. More... | |
| BaseField * | getOutputModifierListFld () const |
| Provide access to output base field if it was created. More... | |
| BaseField * | getInputModifierListFld () 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... | |
| DicomModifyList * | getInputPlugin () 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 Base * | deepCopy () const |
| Creates a deep copy of the given object. More... | |
| bool | isOfAllowedType (const std::vector< const RuntimeType * > &types) const |
| Checks whether this object's type is equal to or derived from one of the types given in the argument. More... | |
| virtual bool | isRefCountedBase () const |
| Returns whether the instance is derived from RefCountedBase. More... | |
| virtual std::string | detailString () const |
| Returns 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 |
| Writes the objects state to the data stream object. More... | |
| virtual void | readFrom (AbstractPersistenceInputStream *, int) |
| Reads 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... | |
| FieldContainer & | getFieldContainer () |
| Returns the referenced container. More... | |
| const FieldContainer & | getFieldContainer () 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... | |
Protected Attributes | |
| EnumField * | _conversionTypeFld |
| The kind of image conversion. 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::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 SC Equipment Module, C.8.8.1.
Definition at line 21 of file mlDicomSCEquipmentModuleTagInterface.h.
Constructor & Destructor Documentation
◆ DicomSCEquipmentModuleTagInterface()
|
inline |
Constructor, setting the reference of the module for which the fields shall be managed.
Definition at line 25 of file mlDicomSCEquipmentModuleTagInterface.h.
Member Function Documentation
◆ addFields()
|
overridevirtual |
Add fields to field container of module.
Reimplemented from ml::DicomModifyFieldAddOnBase.
◆ applyModifications()
|
overridevirtual |
See DicomModifyFieldAddOnBase::applyModifications() for documentation.
Reimplemented from ml::DicomModifyFieldAddOnBase.
◆ checkConsistency()
|
overridevirtual |
Checks for invalid parameters; return textual description on error, or empty string on success.
Reimplemented from ml::DicomModifyFieldAddOnBase.
◆ inheritValues()
|
overridevirtual |
Implements the copy of tag values from the given dcmTree to the fields.
Reimplemented from ml::DicomModifyFieldAddOnBase.
◆ isDigitizedFilmConversionType()
| bool ml::DicomSCEquipmentModuleTagInterface::isDigitizedFilmConversionType | ( | ) | const |
Returns true if conversion type is DigitizedFilm, otherwise false.
◆ isWorkstationConversionType()
| bool ml::DicomSCEquipmentModuleTagInterface::isWorkstationConversionType | ( | ) | const |
Returns true if conversion type is Workstation (WSD) type, otherwise false.
Member Data Documentation
◆ _conversionTypeFld
|
protected |
The kind of image conversion.
Definition at line 48 of file mlDicomSCEquipmentModuleTagInterface.h.
The documentation for this class was generated from the following file:
- FMEstable/ReleaseMeVis/Projects/DICOM/MLDicomTagInterfaces/Sources/DicomTagInterfaces/mlDicomSCEquipmentModuleTagInterface.h
