ml::DicomTagDumpFieldAddOn Class Reference

Class managing fields to show and handle a DICOM tree tag dump. More...

#include <mlDicomTagDumpFieldAddOn.h>

Inheritance diagram for ml::DicomTagDumpFieldAddOn:

Public Member Functions
	DicomTagDumpFieldAddOn (FieldContainer &fieldContainerRef)
	Constructor, setting the reference of the FieldContainer managing the fields.
void	addFields () override
	Add fields to field container of module.
void	handleFieldActivationChanges () override
	Do the activateAttachment-like stuff in this method.
FieldAddOnBase::FieldChangeState	handleFieldChanges (Field *field) override
	Handle field notifications.
virtual std::string	checkConsistency () const
	Checks for invalid parameters; return textual description on error, or empty string on success.
void	setDicomTree (DCMTree::Const_TreePtr dcmTree)
	Updates the field content according to the passed DCMTree.
DCMTree::Const_TreePtr	getDicomTree () const
	Updates the field content according to the passed DCMTree.
void	setAlternativeDumpSource (const ImagePropertyExtensionContainer *extCont=nullptr)
	Optionally sets a copy of an ImagePropertyExtensionContainer as an alternative source for tags dumps.
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.
void	updateTagDump (bool allowAlternativeSource=false)
	Updates the _tagDumpField according to the content of _dcmTree and the current settings of _tagDumpSizeFld and _dumpPrivateTagValuesFld.
IntField &	getTagDumpSizeFld () const
	Provide direct access to the fields; see corresponding fields for comments.
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.
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.

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.
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.

Protected Attributes
DCMTree::Const_TreePtr	_dcmTree
	The DICOM tree.
ImagePropertyExtensionContainer	_imagePropertyExtensions
	A copy of an ImagePropertyExtensionContainer as alternative source for meta data.
Fields for tag dump and related settings.
IntField *	_tagDumpSizeFld
	Maximum size of strings in _tagDumpFld, default is 10000.
BoolField *	_dumpPrivateTagValuesFld
	If enabled then dump contents of private tag values, otherwise only the default information is shown; default is true.
IntField *	_numShownBinaryEntriesFld
	Maximum number of shown binary tags, default is 8.
BoolField *	_annotateFld
	If enabled then the tags in the dump are annotated with additional information, default is off.
StringField *	_regExLineFilterFld
	Regular expression to filter tag dump lines, default is empty or "*." for all lines.
StringField *	_tagDumpFld
	Field with a dump of the DICOM tags of the currently selected volume, default is "".

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()

ml::DicomTagDumpFieldAddOn::DicomTagDumpFieldAddOn ( FieldContainer &  fieldContainerRef )

inline

Constructor, setting the reference of the FieldContainer managing the fields.

Definition at line 27 of file mlDicomTagDumpFieldAddOn.h.

Member Function Documentation

_getAlternativeDump()

std::string ml::DicomTagDumpFieldAddOn::_getAlternativeDump ( ) const

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()

void ml::DicomTagDumpFieldAddOn::addFields ( )

overridevirtual

Add fields to field container of module.

Implements ml::FieldAddOnBase.

checkConsistency()

virtual std::string ml::DicomTagDumpFieldAddOn::checkConsistency ( ) const

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()

BoolField & ml::DicomTagDumpFieldAddOn::getAnnotateFld ( ) const

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()

BoolField & ml::DicomTagDumpFieldAddOn::getDumpPrivateTagValuesFld ( ) const

inline

Definition at line 66 of file mlDicomTagDumpFieldAddOn.h.

getNumShownBinaryEntriesFld()

IntField & ml::DicomTagDumpFieldAddOn::getNumShownBinaryEntriesFld ( ) const

inline

Definition at line 67 of file mlDicomTagDumpFieldAddOn.h.

getRegExLineFilterFld()

StringField & ml::DicomTagDumpFieldAddOn::getRegExLineFilterFld ( ) const

inline

Definition at line 69 of file mlDicomTagDumpFieldAddOn.h.

getTagDumpFld()

StringField & ml::DicomTagDumpFieldAddOn::getTagDumpFld ( ) const

inline

Definition at line 70 of file mlDicomTagDumpFieldAddOn.h.

getTagDumpSizeFld()

IntField & ml::DicomTagDumpFieldAddOn::getTagDumpSizeFld ( ) const

inline

Provide direct access to the fields; see corresponding fields for comments.

Definition at line 65 of file mlDicomTagDumpFieldAddOn.h.

handleFieldActivationChanges()

void ml::DicomTagDumpFieldAddOn::handleFieldActivationChanges ( )

overridevirtual

Do the activateAttachment-like stuff in this method.

Reimplemented from ml::FieldAddOnBase.

handleFieldChanges()

FieldAddOnBase::FieldChangeState ml::DicomTagDumpFieldAddOn::handleFieldChanges ( Field *  field )

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

BoolField* ml::DicomTagDumpFieldAddOn::_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

DCMTree::Const_TreePtr ml::DicomTagDumpFieldAddOn::_dcmTree

protected

The DICOM tree.

Definition at line 79 of file mlDicomTagDumpFieldAddOn.h.

_dumpPrivateTagValuesFld

BoolField* ml::DicomTagDumpFieldAddOn::_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

ImagePropertyExtensionContainer ml::DicomTagDumpFieldAddOn::_imagePropertyExtensions

protected

A copy of an ImagePropertyExtensionContainer as alternative source for meta data.

Definition at line 82 of file mlDicomTagDumpFieldAddOn.h.

_numShownBinaryEntriesFld

IntField* ml::DicomTagDumpFieldAddOn::_numShownBinaryEntriesFld

protected

Maximum number of shown binary tags, default is 8.

Definition at line 95 of file mlDicomTagDumpFieldAddOn.h.

_regExLineFilterFld

StringField* ml::DicomTagDumpFieldAddOn::_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

StringField* ml::DicomTagDumpFieldAddOn::_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

IntField* ml::DicomTagDumpFieldAddOn::_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