#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.
void	addFields () override
	Add fields to field container of module.
void	handleFieldActivationChanges () override
	Handle class changes according to Module::activateAttachments.
FieldAddOnBase::FieldChangeState	handleFieldChanges (Field *field) override
	Handle field notifications according to Module::activateAttachments with a return of field change state.
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
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.

Public Attributes
DicomCopyTagSetInterface	otherManufacturing3DModelModuleTags
	All tags not available in the interface which are from Acquisition Context Module.
DicomCIDSingleEntryEditTagInterface	measurementUnitsCodeSequenceCIDEditor
DicomBoolInheritAndWriteTagInterface	modelModification
DicomBoolInheritAndWriteTagInterface	modelMirroring

Protected Member Functions
std::string	_addManufacturing3DModelModuleTags (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos)
Protected Member Functions inherited from ml::FieldAddOnBase
void	_addFieldPointer (Field *field)

Protected Attributes
StringField *	_contentDescriptionFld

Friends
class	DicomManufacturing3DModelModuleTagInterfaceUnitTest_fieldChecks_Test
	Allow access for GoogleTest.

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.

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.

Implements ml::FieldAddOnBase.

◆ 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::DicomModifyList.

◆ 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::FieldAddOnBase.

◆ 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::FieldAddOnBase.

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

◆ DicomManufacturing3DModelModuleTagInterfaceUnitTest_fieldChecks_Test

friend class DicomManufacturing3DModelModuleTagInterfaceUnitTest_fieldChecks_Test

friend

Allow access for GoogleTest.

Definition at line 74 of file mlDicomManufacturing3DModelModuleTagInterface.h.

References DicomManufacturing3DModelModuleTagInterfaceUnitTest_fieldChecks_Test.

Referenced by DicomManufacturing3DModelModuleTagInterfaceUnitTest_fieldChecks_Test.

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 Symbol Documentation

◆ DicomManufacturing3DModelModuleTagInterfaceUnitTest_fieldChecks_Test

Member Data Documentation

◆ _contentDescriptionFld

◆ measurementUnitsCodeSequenceCIDEditor

◆ modelMirroring

◆ modelModification

◆ otherManufacturing3DModelModuleTags