Manages the module field interface according to DICOM General Equipment, C.7.5.1. More...

#include <mlDicomCopyGroupsTagInterface.h>

Inheritance diagram for ml::DicomCopyGroupsTagInterface:

Public Member Functions
	DicomCopyGroupsTagInterface (Module &modRef, const std::string &fieldSuffix="")
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.
FieldAddOnBase::FieldChangeState	handleFieldChanges (Field *field) override
	Handle field notifications.
std::string	applyModifications (DCMTree::TreePtr dcmTree, const FieldContainer *treeInfos=nullptr) override
	See DicomModifyFieldAddOnBase::applyModifications() for documentation.
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.

Public Attributes
DicomCopyTagSetInterface	clinicalTrialSubjectTags
	Clinical Trial Subject C.7.1.3.
DicomCopyTagSetInterface	clinicalTrialStudyTags
	Clinical Trial Study C.7.2.3.
DicomCopyTagSetInterface	clinicalTrialSeriesTags
	Clinical Trial Series C.7.3.2.
DicomCopyTagSetInterface	synchronizationTags
	Synchronization C.7.4.2.
DicomCopyTagSetInterface	contrastBolusTags
	Contrast/Bolus C.7.6.4.
DicomCopyTagSetInterface	enhancedContrastBolusTags
	Enhanced Contrast/Bolus C.7.6.4b.
DicomCopyTagSetInterface	cardiacSynchronizationTags
	Cardiac Synchronization C.7.6.18.1.
DicomCopyTagSetInterface	respiratorySynchronizationTags
	Respiratory Synchronization C.7.6.18.2.
DicomCopyTagSetInterface	bulkMotionSynchronizationTags
	Bulk Motion Synchronization C.7.6.18.3.
DicomCopyTagSetInterface	deviceTags
	Device C.7.6.12.
DicomCopyTagSetInterface	specimenTags
	Specimen C.7.6.22.
std::vector< DicomCopyTagSetInterface * >	allTagSetInterfaces
	Vector referencing all members to traverse them in loops.

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)

Detailed Description

Manages the module field interface according to DICOM General Equipment, C.7.5.1.

Definition at line 24 of file mlDicomCopyGroupsTagInterface.h.

Constructor & Destructor Documentation

◆ DicomCopyGroupsTagInterface()

ml::DicomCopyGroupsTagInterface::DicomCopyGroupsTagInterface	(	Module &	modRef,
		const std::string &	fieldSuffix = "" )

Constructor, setting the reference of the module for which the fields shall be managed and and option suffix to be appended to all field names for the case that multiple instances are needed in one module.