Manages the module field interface according to Encapsulated Document Module C.24.2. More...

#include <mlDicomEncapsulatedDocumentModuleTagInterface.h>

Inheritance diagram for ml::DicomEncapsulatedDocumentModuleTagInterface:

Public Member Functions
	DicomEncapsulatedDocumentModuleTagInterface (Module &modRef)
	Constructor, setting the reference of the module for which the fields shall be managed.
void	addFields () override
	Add fields to field container of module.
void	inheritValues (DCMTree::Const_TreePtr dcmTree) override
	Implements the copy of tag values from the given dcmTree to the fields.
std::string	applyModifications (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos=nullptr) override
std::string	checkConsistency () const override
	Checks for invalid parameters; return textual description on error, or empty string on success.
Public Member Functions inherited from ml::DicomModifyFieldAddOnBase
	DicomModifyFieldAddOnBase (FieldContainer &fieldContainerRef, size_t numInstances=1, bool createInputModifyTagsPluginBaseConnectorField=false, bool createOutputModifyTagsPluginBaseConnectorField=false)
	~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
void	addFields () override
	Add fields to field container of the FieldAddOn.
void	handleFieldActivationChanges () override
	Handle class changes according to Module::activateAttachments.
FieldAddOnBase::FieldChangeState	handleFieldChanges (Field *field) override
	Handle field notifications according to Module::handleNotification with a return of field change state.
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 ()
	~DicomModifyList () override
	Destructor also destroying all of its stored Modifiers.
void	addModifier (DicomModifyBase *modifier, bool atEnd=true)
void	clear ()
	Makes modifier array empty and deletes all of them.
std::vector< DicomModifyBase * > &	getModifierList ()
const std::vector< DicomModifyBase * > &	getModifierList () const
	Same as getModifierList() only for constant access.
void	setInputPlugin (DicomModifyList *inputPlugin=nullptr)
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
bool	isOfAllowedType (const std::vector< const RuntimeType * > &types) const
virtual bool	isRefCountedBase () const
	Returns whether the instance is derived from RefCountedBase.
virtual std::string	detailString () const
virtual bool	implementsPersistence (PersistenceInterface) const
virtual std::string	persistentState () const
	Returns a string describing the object's internal state.
virtual void	setPersistentState (const std::string &state)
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
virtual void	readFrom (AbstractPersistenceInputStream *, int)
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.

Static Public Member Functions
static std::string	addBinaryDocumentData (DCMTree::TreePtr dcmTree, const std::string &fileName, const MLint fileSize)
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.

Public Attributes
DicomGeneralImageModuleTagInterface	instanceNumberAndContentFieldAddOn
DicomContentDateTimeTagInterface	acquisitionDateTimeFieldsAddOn
	Used to add acquisition Date and Time tags.
DicomBoolInheritAndWriteTagInterface	burnedInAnnotationAddOn
	Manages burnedInAnnotation tag.
DicomBoolInheritAndWriteTagInterface	recognizableVisualFeaturesAddOn
	Manages recognizableVisualFeatures tag.
StringField *	_documentTitleFld
	Tag Document Title (0042,0010), Type 2.

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...
Protected Member Functions inherited from ml::FieldAddOnBase
void	_addFieldPointer (Field *field)

Detailed Description

Manages the module field interface according to Encapsulated Document Module C.24.2.

Definition at line 24 of file mlDicomEncapsulatedDocumentModuleTagInterface.h.

Constructor & Destructor Documentation

◆ DicomEncapsulatedDocumentModuleTagInterface()

ml::DicomEncapsulatedDocumentModuleTagInterface::DicomEncapsulatedDocumentModuleTagInterface ( Module & modRef )

Constructor, setting the reference of the module for which the fields shall be managed.

Member Function Documentation

◆ addBinaryDocumentData()

std::string ml::DicomEncapsulatedDocumentModuleTagInterface::addBinaryDocumentData	(	DCMTree::TreePtr	dcmTree,
		const std::string &	fileName,
		const MLint	fileSize )

static

Helper routine to add the content of fileName to dcmTree as OB data of tag Encapsulated Document (0042,0011); on success an empty string is returned, otherwise a descriptive error message; fileSize must match the content size of the fileName; DCMTree::Exceptions are not caught.

◆ addFields()

void ml::DicomEncapsulatedDocumentModuleTagInterface::addFields ( )

overridevirtual

Add fields to field container of module.

Implements ml::FieldAddOnBase.

◆ applyModifications()

std::string ml::DicomEncapsulatedDocumentModuleTagInterface::applyModifications	(	DCMTree::TreePtr	dcmTree,
		const FieldContainer *	treeInfos = nullptr )

overridevirtual

See DicomModifyFieldAddOnBase::applyModifications() for documentation; the mandatory tags Encapsulated Document (0042,0011) and MIME Type Of Encapsulated Document (0042,0012) are not added and must be handled explicitly; see also addBinaryDocumentData() as helper for the first one.

Reimplemented from ml::DicomModifyList.

◆ checkConsistency()

std::string ml::DicomEncapsulatedDocumentModuleTagInterface::checkConsistency ( ) const

overridevirtual

Checks for invalid parameters; return textual description on error, or empty string on success.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ inheritValues()

void ml::DicomEncapsulatedDocumentModuleTagInterface::inheritValues ( DCMTree::Const_TreePtr dcmTree )

overridevirtual

Implements the copy of tag values from the given dcmTree to the fields.

Reimplemented from ml::DicomModifyFieldAddOnBase.

Member Data Documentation

◆ _documentTitleFld

StringField* ml::DicomEncapsulatedDocumentModuleTagInterface::_documentTitleFld

Tag Document Title (0042,0010), Type 2.

Definition at line 66 of file mlDicomEncapsulatedDocumentModuleTagInterface.h.

◆ acquisitionDateTimeFieldsAddOn

DicomContentDateTimeTagInterface ml::DicomEncapsulatedDocumentModuleTagInterface::acquisitionDateTimeFieldsAddOn

Used to add acquisition Date and Time tags.

Definition at line 57 of file mlDicomEncapsulatedDocumentModuleTagInterface.h.

◆ burnedInAnnotationAddOn

DicomBoolInheritAndWriteTagInterface ml::DicomEncapsulatedDocumentModuleTagInterface::burnedInAnnotationAddOn

Manages burnedInAnnotation tag.

Definition at line 60 of file mlDicomEncapsulatedDocumentModuleTagInterface.h.

◆ instanceNumberAndContentFieldAddOn

DicomGeneralImageModuleTagInterface ml::DicomEncapsulatedDocumentModuleTagInterface::instanceNumberAndContentFieldAddOn

Fields. used for InstanceNumber, Content Data, and Content Time.

Definition at line 54 of file mlDicomEncapsulatedDocumentModuleTagInterface.h.

◆ recognizableVisualFeaturesAddOn

DicomBoolInheritAndWriteTagInterface ml::DicomEncapsulatedDocumentModuleTagInterface::recognizableVisualFeaturesAddOn

Manages recognizableVisualFeatures tag.

Definition at line 63 of file mlDicomEncapsulatedDocumentModuleTagInterface.h.

The documentation for this class was generated from the following file:

FMEstable/ReleaseMeVis/Projects/DICOM/MLDicomTagInterfaces/Sources/DicomTagInterfaces/mlDicomEncapsulatedDocumentModuleTagInterface.h

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DicomEncapsulatedDocumentModuleTagInterface()

Member Function Documentation

◆ addBinaryDocumentData()

◆ addFields()

◆ applyModifications()

◆ checkConsistency()

◆ inheritValues()

Member Data Documentation

◆ _documentTitleFld

◆ acquisitionDateTimeFieldsAddOn

◆ burnedInAnnotationAddOn

◆ instanceNumberAndContentFieldAddOn

◆ recognizableVisualFeaturesAddOn