Manages the module field interface according to DICOM Manufacturing 3D Model Module C.35, currently only by adding Measurement Units Sequence with one CID 7063 entry. More...

#include <mlDicomManufacturing3DModelModuleTagInterface.h>

Inheritance diagram for ml::DicomManufacturing3DModelModuleTagInterface:

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

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

void	handleFieldActivationChanges () override
	Handle class changes according to Module::activateAttachments. More...

FieldAddOnBase::FieldChangeState	handleFieldChanges (Field *field) override
	Handle field notifications according to Module::activateAttachments 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...

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

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

Public Attributes
DicomCopyTagSetInterface	otherManufacturing3DModelModuleTags
	All tags not available in the interface which are from Acquisition Context Module. More...

DicomCIDSingleEntryEditTagInterface	measurementUnitsCodeSequenceCIDEditor
	Mandatory handler for the Manufactoring 3D model, used for the Measurement Units Code Sequence. More...

DicomBoolInheritAndWriteTagInterface	modelModification
	Model Modification (0068,7001) Specifies whether a modification of the observed anatomy (other than mirroring) was used to create the model (e.g. More...

DicomBoolInheritAndWriteTagInterface	modelMirroring
	Model Mirroring (0068,7002) Specifies whether mirroring of anatomy from the other side of the patient was used to create the model. More...

Protected Member Functions
std::string	_addManufacturing3DModelModuleTags (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos)
	Sets the tags for Manufacturing3DModelModule and related tags and returns an empty string on success, otherwise a descriptive error message, arguments are the same as for applyModifications(). 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...

Protected Attributes
StringField *	_contentDescriptionFld
	Content Description (0070,0081) A description of the model, Vr LO, maximum 64 bytes. More...

Friends
class	DicomManufacturing3DModelModuleTagInterfaceUnitTest_fieldChecks_Test
	Allow access for GoogleTest. 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...

Detailed Description

Manages the module field interface according to DICOM Manufacturing 3D Model Module C.35, currently only by adding Measurement Units Sequence with one CID 7063 entry.

Definition at line 25 of file mlDicomManufacturing3DModelModuleTagInterface.h.

Constructor & Destructor Documentation

◆ DicomManufacturing3DModelModuleTagInterface()

ml::DicomManufacturing3DModelModuleTagInterface::DicomManufacturing3DModelModuleTagInterface ( Module & modRef )

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

Member Function Documentation

◆ _addManufacturing3DModelModuleTags()

std::string ml::DicomManufacturing3DModelModuleTagInterface::_addManufacturing3DModelModuleTags	(	DCMTree::TreePtr	dcmTree,
		const FieldContainer *	treeInfos
	)

protected

Sets the tags for Manufacturing3DModelModule and related tags and returns an empty string on success, otherwise a descriptive error message, arguments are the same as for applyModifications().

◆ addFields()

void ml::DicomManufacturing3DModelModuleTagInterface::addFields ( )

overridevirtual

Add fields to field container of module.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ applyModifications()

std::string ml::DicomManufacturing3DModelModuleTagInterface::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.

◆ checkConsistency()

std::string ml::DicomManufacturing3DModelModuleTagInterface::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.

◆ handleFieldActivationChanges()

void ml::DicomManufacturing3DModelModuleTagInterface::handleFieldActivationChanges ( )

overridevirtual

Handle class changes according to Module::activateAttachments.

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ handleFieldChanges()

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

overridevirtual

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

Reimplemented from ml::DicomModifyFieldAddOnBase.

◆ inheritValues()

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

overridevirtual

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

Reimplemented from ml::DicomModifyFieldAddOnBase.

Friends And Related Function Documentation

◆ DicomManufacturing3DModelModuleTagInterfaceUnitTest_fieldChecks_Test

friend class DicomManufacturing3DModelModuleTagInterfaceUnitTest_fieldChecks_Test

friend

Allow access for GoogleTest.

Definition at line 74 of file mlDicomManufacturing3DModelModuleTagInterface.h.

Member Data Documentation

◆ _contentDescriptionFld

StringField* ml::DicomManufacturing3DModelModuleTagInterface::_contentDescriptionFld

protected

Content Description (0070,0081) A description of the model, Vr LO, maximum 64 bytes.

Definition at line 82 of file mlDicomManufacturing3DModelModuleTagInterface.h.

◆ measurementUnitsCodeSequenceCIDEditor

DicomCIDSingleEntryEditTagInterface ml::DicomManufacturing3DModelModuleTagInterface::measurementUnitsCodeSequenceCIDEditor

Mandatory handler for the Manufactoring 3D model, used for the Measurement Units Code Sequence.

Definition at line 58 of file mlDicomManufacturing3DModelModuleTagInterface.h.

◆ modelMirroring

DicomBoolInheritAndWriteTagInterface ml::DicomManufacturing3DModelModuleTagInterface::modelMirroring

Model Mirroring (0068,7002) Specifies whether mirroring of anatomy from the other side of the patient was used to create the model.

Definition at line 70 of file mlDicomManufacturing3DModelModuleTagInterface.h.

◆ modelModification

DicomBoolInheritAndWriteTagInterface ml::DicomManufacturing3DModelModuleTagInterface::modelModification

Model Modification (0068,7001) Specifies whether a modification of the observed anatomy (other than mirroring) was used to create the model (e.g.

simulating an expected surgical result). In the negative, the model follows the observed patient anatomy in the source data.

Definition at line 65 of file mlDicomManufacturing3DModelModuleTagInterface.h.

◆ otherManufacturing3DModelModuleTags

DicomCopyTagSetInterface ml::DicomManufacturing3DModelModuleTagInterface::otherManufacturing3DModelModuleTags

All tags not available in the interface which are from Acquisition Context Module.

Definition at line 54 of file mlDicomManufacturing3DModelModuleTagInterface.h.

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DicomManufacturing3DModelModuleTagInterface()

Member Function Documentation

◆ _addManufacturing3DModelModuleTags()

◆ addFields()

◆ applyModifications()

◆ checkConsistency()

◆ handleFieldActivationChanges()

◆ handleFieldChanges()

◆ inheritValues()

Friends And Related Function Documentation

◆ DicomManufacturing3DModelModuleTagInterfaceUnitTest_fieldChecks_Test

Member Data Documentation

◆ _contentDescriptionFld

◆ measurementUnitsCodeSequenceCIDEditor

◆ modelMirroring

◆ modelModification

◆ otherManufacturing3DModelModuleTags