Manages the module field interface according to Common Instance Reference Module in DICOM Part 3. More...

#include <mlDicomReferencedImageSequenceTagInterface.h>

Inheritance diagram for ml::DicomReferencedImageSequenceTagInterface:

Public Member Functions
	DicomReferencedImageSequenceTagInterface (Module &modRef)
	Constructor, setting the reference of the module for which the fields shall be managed. More...

void	setInputPagedImage (PagedImage &inImg)
	Sets the input image from which the DICOM information of the reference image shall be inherited. More...

void	addFields () override
	Add fields to field container of module. More...

FieldAddOnBase::FieldChangeState	handleFieldChanges (Field *field) override
	Handle field notifications according to Module::handleNotification with a return of field change state. 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; adds field values as tags to dcmTree. More...

std::string	checkConsistency () const override
	Checks for invalid parameters; return textual description on error, or empty string on success; requires that setInputPagedImage was called with a valid image before for successful proper operation. More...

BoolField &	getMakeGUIInsensitiveFld ()
	Return reference to _makeGUIInsensitiveFld to allow modules hosting this add to change sensitivity. More...

void	setStudyInstanceUIDFieldPointer (StringField *studyInstanceUIDFldPointer)
	Stores the StudyInstanceUID field created somewhere else; in handle field changes it can be used whether it is changed and the content can be used for updates of the two DicomSeriesAndInstanceReferenceMacroTagInterface FieldAddOns. More...

StringField *	getStudyInstanceUIDFieldPointer () const
	Returns the pointer set with setStudyInstanceUIDFieldPointer or nullptr if still not set.. More...

virtual bool	areAllFieldsEmpty () const
	Returns true if all fields are empty, otherwise false. More...

virtual void	clearFields ()
	Make all fields empty. 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...

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
	Set addStateToTree version number that can be accessed via getAddStateVersion() More...

bool	isOfAllowedType (const std::vector< const RuntimeType * > &types) const
	Check if this object's type is equal to or derived from one of the types given in the argument. More...

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

virtual std::string	detailString () const
	Return 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
	Write the objects state to the data stream object. More...

virtual void	readFrom (AbstractPersistenceInputStream *, int)
	Read 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 *	_inputConnectorSelectorFld
	Fields. More...

NotifyField *	_clearReferencedImageSequenceFieldsFld
	If notified then all fields are reset to empty strings. More...

NotifyField *	_updateReferencedImageSequenceUIDInheritanceFld
	If the _mainStudyInstanceUID has been changed then a manual update of the inherited UIDs may be required which can be triggered with this field. More...

StringField *	_referencedFrameNumbersFld
	Space separated values to be written into Referenced Frame Number tags if non empty; otherwise not written at all. More...

StringField *	_referencedSegmentNumbersFld
	Values to be written into Referenced Segment Number tags if non empty; otherwise not written at all. 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::Base
virtual char *	getPersistentState () const
	Returns a C string describing the object's internal state. More...

virtual void	setPersistentState (const char *)
	Restores the object's internal state from a string that had been previously generated using `getPersistentState()`. More...

virtual void	clearPersistentState (char *) const
	Disposes a string previously allocated by `getPersistentState()`. 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 Common Instance Reference Module in DICOM Part 3.

Definition at line 22 of file mlDicomReferencedImageSequenceTagInterface.h.

Constructor & Destructor Documentation

◆ DicomReferencedImageSequenceTagInterface()

ml::DicomReferencedImageSequenceTagInterface::DicomReferencedImageSequenceTagInterface ( Module & modRef )

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

Member Function Documentation

◆ addFields()

void ml::DicomReferencedImageSequenceTagInterface::addFields ( )

overridevirtual

Add fields to field container of module.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ applyModifications()

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

overridevirtual

See DicomModifyFieldAddOnBase::applyModifications() for documentation; adds field values as tags to dcmTree.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ areAllFieldsEmpty()

virtual bool ml::DicomReferencedImageSequenceTagInterface::areAllFieldsEmpty ( ) const

virtual

Returns true if all fields are empty, otherwise false.

◆ checkConsistency()

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

overridevirtual

Checks for invalid parameters; return textual description on error, or empty string on success; requires that setInputPagedImage was called with a valid image before for successful proper operation.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ clearFields()

virtual void ml::DicomReferencedImageSequenceTagInterface::clearFields ( )

virtual

Make all fields empty.

◆ getMakeGUIInsensitiveFld()

BoolField& ml::DicomReferencedImageSequenceTagInterface::getMakeGUIInsensitiveFld ( )

Return reference to _makeGUIInsensitiveFld to allow modules hosting this add to change sensitivity.

◆ getStudyInstanceUIDFieldPointer()

StringField* ml::DicomReferencedImageSequenceTagInterface::getStudyInstanceUIDFieldPointer ( ) const

Returns the pointer set with setStudyInstanceUIDFieldPointer or nullptr if still not set..

◆ handleFieldChanges()

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

overridevirtual

Handle field notifications according to Module::handleNotification with a return of field change state.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ inheritValues()

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

overridevirtual

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

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ setInputPagedImage()

void ml::DicomReferencedImageSequenceTagInterface::setInputPagedImage ( PagedImage & inImg )

Sets the input image from which the DICOM information of the reference image shall be inherited.

◆ setStudyInstanceUIDFieldPointer()

void ml::DicomReferencedImageSequenceTagInterface::setStudyInstanceUIDFieldPointer ( StringField * studyInstanceUIDFldPointer )

Stores the StudyInstanceUID field created somewhere else; in handle field changes it can be used whether it is changed and the content can be used for updates of the two DicomSeriesAndInstanceReferenceMacroTagInterface FieldAddOns.

Member Data Documentation

◆ _clearReferencedImageSequenceFieldsFld

NotifyField* ml::DicomReferencedImageSequenceTagInterface::_clearReferencedImageSequenceFieldsFld

protected

If notified then all fields are reset to empty strings.

Definition at line 74 of file mlDicomReferencedImageSequenceTagInterface.h.

◆ _inputConnectorSelectorFld

EnumField* ml::DicomReferencedImageSequenceTagInterface::_inputConnectorSelectorFld

protected

Fields.

Selects the image connector from which the ImageReferences shall be inherited.

Definition at line 71 of file mlDicomReferencedImageSequenceTagInterface.h.

◆ _referencedFrameNumbersFld

StringField* ml::DicomReferencedImageSequenceTagInterface::_referencedFrameNumbersFld

protected

Space separated values to be written into Referenced Frame Number tags if non empty; otherwise not written at all.

Definition at line 81 of file mlDicomReferencedImageSequenceTagInterface.h.

◆ _referencedSegmentNumbersFld

StringField* ml::DicomReferencedImageSequenceTagInterface::_referencedSegmentNumbersFld

protected

Values to be written into Referenced Segment Number tags if non empty; otherwise not written at all.

Definition at line 84 of file mlDicomReferencedImageSequenceTagInterface.h.

◆ _updateReferencedImageSequenceUIDInheritanceFld

NotifyField* ml::DicomReferencedImageSequenceTagInterface::_updateReferencedImageSequenceUIDInheritanceFld

protected

If the _mainStudyInstanceUID has been changed then a manual update of the inherited UIDs may be required which can be triggered with this field.

Definition at line 78 of file mlDicomReferencedImageSequenceTagInterface.h.

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DicomReferencedImageSequenceTagInterface()

Member Function Documentation

◆ addFields()

◆ applyModifications()

◆ areAllFieldsEmpty()

◆ checkConsistency()

◆ clearFields()

◆ getMakeGUIInsensitiveFld()

◆ getStudyInstanceUIDFieldPointer()

◆ handleFieldChanges()

◆ inheritValues()

◆ setInputPagedImage()

◆ setStudyInstanceUIDFieldPointer()

Member Data Documentation

◆ _clearReferencedImageSequenceFieldsFld

◆ _inputConnectorSelectorFld

◆ _referencedFrameNumbersFld

◆ _referencedSegmentNumbersFld

◆ _updateReferencedImageSequenceUIDInheritanceFld