Class managing fields to show and handle a DICOM tree tag dump. More...
#include <mlDicomTagDumpFieldAddOn.h>
Public Member Functions | |
| DicomTagDumpFieldAddOn (FieldContainer &fieldContainerRef) | |
| Constructor, setting the reference of the FieldContainer managing the fields. More... | |
| void | addFields () override |
| Add fields to field container of module. More... | |
| void | handleFieldActivationChanges () override |
| Do the activateAttachment-like stuff in this method. More... | |
| FieldAddOnBase::FieldChangeState | handleFieldChanges (Field *field) override |
| Handle field notifications. More... | |
| virtual std::string | checkConsistency () const |
| Checks for invalid parameters; return textual description on error, or empty string on success. More... | |
| void | setDicomTree (DCMTree::Const_TreePtr dcmTree) |
| Updates the field content according to the passed DCMTree. More... | |
| DCMTree::Const_TreePtr | getDicomTree () const |
| Updates the field content according to the passed DCMTree. More... | |
| void | setAlternativeDumpSource (const ImagePropertyExtensionContainer *extCont=nullptr) |
| Optionally sets a copy of an ImagePropertyExtensionContainer as an alternative source for tags dumps. More... | |
| const ImagePropertyExtensionContainer & | getAlternativeDumpSource () const |
| Returns the reference to the currently set copy of an ImagePropertyExtensionContainer which might be used as as an alternative source for tags dumps. More... | |
| void | updateTagDump (bool allowAlternativeSource=false) |
| Updates the _tagDumpField according to the content of _dcmTree and the current settings of _tagDumpSizeFld and _dumpPrivateTagValuesFld. More... | |
| IntField & | getTagDumpSizeFld () const |
| Provide direct access to the fields; see corresponding fields for comments. More... | |
| BoolField & | getDumpPrivateTagValuesFld () const |
| IntField & | getNumShownBinaryEntriesFld () const |
| BoolField & | getAnnotateFld () const |
| StringField & | getRegExLineFilterFld () const |
| StringField & | getTagDumpFld () const |
 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 Member Functions | |
| std::string | _getAlternativeDump () const |
| Calculated the string dump of an alternative source, currently the new-line-separated list of string dumps of all non-DICOMTreeImagePropertyExtensions in _imagePropertyExtensions. 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... | |
Protected Attributes | |
| DCMTree::Const_TreePtr | _dcmTree |
| The DICOM tree. More... | |
| ImagePropertyExtensionContainer | _imagePropertyExtensions |
| A copy of an ImagePropertyExtensionContainer as alternative source for meta data. More... | |
Fields for tag dump and related settings. | |
| IntField * | _tagDumpSizeFld |
| Maximum size of strings in _tagDumpFld, default is 10000. More... | |
| BoolField * | _dumpPrivateTagValuesFld |
| If enabled then dump contents of private tag values, otherwise only the default information is shown; default is true. More... | |
| IntField * | _numShownBinaryEntriesFld |
| Maximum number of shown binary tags, default is 8. More... | |
| BoolField * | _annotateFld |
| If enabled then the tags in the dump are annotated with additional information, default is off. More... | |
| StringField * | _regExLineFilterFld |
| Regular expression to filter tag dump lines, default is empty or "*." for all lines. More... | |
| StringField * | _tagDumpFld |
| Field with a dump of the DICOM tags of the currently selected volume, default is "". More... | |
Additional Inherited Members | |
| 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... | |
Detailed Description
Class managing fields to show and handle a DICOM tree tag dump.
Definition at line 23 of file mlDicomTagDumpFieldAddOn.h.
Constructor & Destructor Documentation
◆ DicomTagDumpFieldAddOn()
|
inline |
Constructor, setting the reference of the FieldContainer managing the fields.
Definition at line 27 of file mlDicomTagDumpFieldAddOn.h.
Member Function Documentation
◆ _getAlternativeDump()
|
protected |
Calculated the string dump of an alternative source, currently the new-line-separated list of string dumps of all non-DICOMTreeImagePropertyExtensions in _imagePropertyExtensions.
◆ addFields()
|
overridevirtual |
Add fields to field container of module.
Implements ml::FieldAddOnBase.
◆ checkConsistency()
|
virtual |
Checks for invalid parameters; return textual description on error, or empty string on success.
◆ getAlternativeDumpSource()
| const ImagePropertyExtensionContainer& ml::DicomTagDumpFieldAddOn::getAlternativeDumpSource | ( | ) | const |
Returns the reference to the currently set copy of an ImagePropertyExtensionContainer which might be used as as an alternative source for tags dumps.
◆ getAnnotateFld()
|
inline |
Definition at line 68 of file mlDicomTagDumpFieldAddOn.h.
◆ getDicomTree()
| DCMTree::Const_TreePtr ml::DicomTagDumpFieldAddOn::getDicomTree | ( | ) | const |
Updates the field content according to the passed DCMTree.
◆ getDumpPrivateTagValuesFld()
|
inline |
Definition at line 66 of file mlDicomTagDumpFieldAddOn.h.
◆ getNumShownBinaryEntriesFld()
|
inline |
Definition at line 67 of file mlDicomTagDumpFieldAddOn.h.
◆ getRegExLineFilterFld()
|
inline |
Definition at line 69 of file mlDicomTagDumpFieldAddOn.h.
◆ getTagDumpFld()
|
inline |
Definition at line 70 of file mlDicomTagDumpFieldAddOn.h.
◆ getTagDumpSizeFld()
|
inline |
Provide direct access to the fields; see corresponding fields for comments.
Definition at line 65 of file mlDicomTagDumpFieldAddOn.h.
◆ handleFieldActivationChanges()
|
overridevirtual |
Do the activateAttachment-like stuff in this method.
Reimplemented from ml::FieldAddOnBase.
◆ handleFieldChanges()
|
overridevirtual |
Handle field notifications.
Reimplemented from ml::FieldAddOnBase.
◆ setAlternativeDumpSource()
| void ml::DicomTagDumpFieldAddOn::setAlternativeDumpSource | ( | const ImagePropertyExtensionContainer * | extCont = nullptr | ) |
Optionally sets a copy of an ImagePropertyExtensionContainer as an alternative source for tags dumps.
All non-DICOMTreeImagePropertyExtensions will be dumped as string if alternative tag dumps are used. Passing nullptr will clear the currently set copy of the container.
◆ setDicomTree()
| void ml::DicomTagDumpFieldAddOn::setDicomTree | ( | DCMTree::Const_TreePtr | dcmTree | ) |
Updates the field content according to the passed DCMTree.
◆ updateTagDump()
| void ml::DicomTagDumpFieldAddOn::updateTagDump | ( | bool | allowAlternativeSource = false | ) |
Updates the _tagDumpField according to the content of _dcmTree and the current settings of _tagDumpSizeFld and _dumpPrivateTagValuesFld.
If _dcmTree is nullptr and allowAlternativeSource is true then the currently set alternative information source is dumped.
Member Data Documentation
◆ _annotateFld
|
protected |
If enabled then the tags in the dump are annotated with additional information, default is off.
Definition at line 98 of file mlDicomTagDumpFieldAddOn.h.
◆ _dcmTree
|
protected |
The DICOM tree.
Definition at line 79 of file mlDicomTagDumpFieldAddOn.h.
◆ _dumpPrivateTagValuesFld
|
protected |
If enabled then dump contents of private tag values, otherwise only the default information is shown; default is true.
Definition at line 92 of file mlDicomTagDumpFieldAddOn.h.
◆ _imagePropertyExtensions
|
protected |
A copy of an ImagePropertyExtensionContainer as alternative source for meta data.
Definition at line 82 of file mlDicomTagDumpFieldAddOn.h.
◆ _numShownBinaryEntriesFld
|
protected |
Maximum number of shown binary tags, default is 8.
Definition at line 95 of file mlDicomTagDumpFieldAddOn.h.
◆ _regExLineFilterFld
|
protected |
Regular expression to filter tag dump lines, default is empty or "*." for all lines.
Definition at line 101 of file mlDicomTagDumpFieldAddOn.h.
◆ _tagDumpFld
|
protected |
Field with a dump of the DICOM tags of the currently selected volume, default is "".
Definition at line 104 of file mlDicomTagDumpFieldAddOn.h.
◆ _tagDumpSizeFld
|
protected |
Maximum size of strings in _tagDumpFld, default is 10000.
Definition at line 88 of file mlDicomTagDumpFieldAddOn.h.
The documentation for this class was generated from the following file:
- FMEstable/ReleaseMeVis/Projects/DICOM/MLDicomToMLTools/Sources/mlDicomTagDumpFieldAddOn.h
