Manages the module field interface according to DICOM General Series, C.24.1. More...

#include <mlDicomEncapsulatedDocumentSeriesModuleTagInterface.h>

Inheritance diagram for ml::DicomEncapsulatedDocumentSeriesModuleTagInterface:

Public Member Functions
	DicomEncapsulatedDocumentSeriesModuleTagInterface (Module &modRef, const std::string &modality="")
	Constructor, setting the reference of the module for which the fields shall be managed.

void	setModality (const std::string &modality)
	Sets the modality value to be used; if an empty string is used, then no modality tag is set.

std::string	getModality () const
	Returns the currently set document type as string or an empty string if not set.

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
	See DicomModifyFieldAddOnBase::applyModifications() for documentation.

FieldAddOnBase::FieldChangeState	handleFieldChanges (Field *field) override
	Handle field notifications.

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

	~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
	Applies first the changes to the dcmTree as described in DicomModifyList::applyModifications() and then calls applyModifications() on all connected input DicomModifyList objects.

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 ()
	Constructor creating an empty list of tag modifiers and setting the optional input plugin with a concatenated DicomModifyList.

	~DicomModifyList () override
	Destructor also destroying all of its stored Modifiers.

void	addModifier (DicomModifyBase *modifier, bool atEnd=true)
	Add an object derived from DicomModifyBase which then will be owned (and on destruction deleted) by this.

void	clear ()
	Makes modifier array empty and deletes all of them.

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.

const std::vector< DicomModifyBase * > &	getModifierList () const
	Same as getModifierList() only for constant access.

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.

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
	Creates a deep copy of the given object.

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.

virtual bool	isRefCountedBase () const
	Returns whether the instance is derived from RefCountedBase.

virtual std::string	detailString () const
	Returns a string describing this object.

virtual bool	implementsPersistence (PersistenceInterface) const
	Override this method to declare which persistence interfaces are implemented by your derived class.

virtual std::string	persistentState () const
	Returns a string describing the object's internal state.

virtual void	setPersistentState (const std::string &state)
	Restores the object's internal state from a string that had been previously generated using persistentState().

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
	Writes the objects state to the data stream object.

virtual void	readFrom (AbstractPersistenceInputStream *, int)
	Reads the objects state from the data stream object.

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.

Public Attributes
DicomValueInheritAndCreateTagInterface	_seriesInstanceUIDAddOn
	Fields.

StringField *	_seriesNumberFld
	Content of the corresponding DICOM tag definition.

BoolField *	_inheritSeriesNumberFld
	If true then the seriesNumber field is overwritten with inherited states, otherwise not.

StringField *	_seriesDescriptionFld
	Describes the series for which this DICOM file is created.

DicomCopyTagSetInterface	_otherEncapsulatedDocumentSeriesTags
	All other Encapsulated Document Series tags not available in the interface, allow public access.

Protected Attributes
std::string	_modality
	If not empty then the content will be set as Modality tag, otherwise ignored.

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.

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.

Detailed Description

Manages the module field interface according to DICOM General Series, C.24.1.

Definition at line 23 of file mlDicomEncapsulatedDocumentSeriesModuleTagInterface.h.

Constructor & Destructor Documentation

◆ DicomEncapsulatedDocumentSeriesModuleTagInterface()

ml::DicomEncapsulatedDocumentSeriesModuleTagInterface::DicomEncapsulatedDocumentSeriesModuleTagInterface	(	Module &	modRef,
		const std::string &	modality = `""`
	)

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

Parameters

modRef	The reference to the ML Module instance in which this FieldAdddOn will be inserted.
modality	Ignored if empty; if not empty then the Modality tag is added with the given string as value.

Member Function Documentation

◆ addFields()

void ml::DicomEncapsulatedDocumentSeriesModuleTagInterface::addFields ( )

overridevirtual

Add fields to field container of module.

Implements ml::FieldAddOnBase.

◆ applyModifications()

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

overridevirtual

See DicomModifyFieldAddOnBase::applyModifications() for documentation.

Reimplemented from ml::DicomModifyList.

◆ checkConsistency()

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

overridevirtual

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

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ getModality()

std::string ml::DicomEncapsulatedDocumentSeriesModuleTagInterface::getModality ( ) const

Returns the currently set document type as string or an empty string if not set.

◆ handleFieldChanges()

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

overridevirtual

Handle field notifications.

Reimplemented from ml::FieldAddOnBase.

◆ inheritValues()

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

overridevirtual

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

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ setModality()

void ml::DicomEncapsulatedDocumentSeriesModuleTagInterface::setModality ( const std::string & modality )

Sets the modality value to be used; if an empty string is used, then no modality tag is set.

Member Data Documentation

◆ _inheritSeriesNumberFld

BoolField* ml::DicomEncapsulatedDocumentSeriesModuleTagInterface::_inheritSeriesNumberFld

If true then the seriesNumber field is overwritten with inherited states, otherwise not.

Definition at line 67 of file mlDicomEncapsulatedDocumentSeriesModuleTagInterface.h.

◆ _modality

std::string ml::DicomEncapsulatedDocumentSeriesModuleTagInterface::_modality

protected

If not empty then the content will be set as Modality tag, otherwise ignored.

Definition at line 78 of file mlDicomEncapsulatedDocumentSeriesModuleTagInterface.h.

◆ _otherEncapsulatedDocumentSeriesTags

DicomCopyTagSetInterface ml::DicomEncapsulatedDocumentSeriesModuleTagInterface::_otherEncapsulatedDocumentSeriesTags

All other Encapsulated Document Series tags not available in the interface, allow public access.

Definition at line 74 of file mlDicomEncapsulatedDocumentSeriesModuleTagInterface.h.

◆ _seriesDescriptionFld

StringField* ml::DicomEncapsulatedDocumentSeriesModuleTagInterface::_seriesDescriptionFld

Describes the series for which this DICOM file is created.

Definition at line 70 of file mlDicomEncapsulatedDocumentSeriesModuleTagInterface.h.

◆ _seriesInstanceUIDAddOn

DicomValueInheritAndCreateTagInterface ml::DicomEncapsulatedDocumentSeriesModuleTagInterface::_seriesInstanceUIDAddOn

Fields.

FieldAddOn managing field value, create mode, inherit modes, create button etc. for the SeriesInstanceUID.

Definition at line 62 of file mlDicomEncapsulatedDocumentSeriesModuleTagInterface.h.

◆ _seriesNumberFld

StringField* ml::DicomEncapsulatedDocumentSeriesModuleTagInterface::_seriesNumberFld

Content of the corresponding DICOM tag definition.

Definition at line 65 of file mlDicomEncapsulatedDocumentSeriesModuleTagInterface.h.

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

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

Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DicomEncapsulatedDocumentSeriesModuleTagInterface()

Member Function Documentation

◆ addFields()

◆ applyModifications()

◆ checkConsistency()

◆ getModality()

◆ handleFieldChanges()

◆ inheritValues()

◆ setModality()

Member Data Documentation

◆ _inheritSeriesNumberFld

◆ _modality

◆ _otherEncapsulatedDocumentSeriesTags

◆ _seriesDescriptionFld

◆ _seriesInstanceUIDAddOn

◆ _seriesNumberFld