ml::DicomModifyModuleFieldAddOnBase Class Reference

#include <mlDicomModifyModuleFieldAddOnBase.h>

Inheritance diagram for ml::DicomModifyModuleFieldAddOnBase:

Public Member Functions
	DicomModifyModuleFieldAddOnBase (FieldContainer &fieldContainer, const std::string &dicomModuleName, bool createInputModifyTagsPluginBaseConnectorField=false, bool createOutputModifyTagsPluginBaseConnectorField=false)
void	setInputDicomTreeField (BaseField *field)
virtual void	addFields () override
	Add fields to field container of the FieldAddOn.
virtual FieldAddOnBase::FieldChangeState	handleFieldChanges (Field *field) override
	Handle field notifications according to Module::handleNotification with a return of field change state.
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	handleFieldActivationChanges () override
	Handle class changes according to Module::activateAttachments.
virtual void	inheritValues (DCMTree::Const_TreePtr)
	Can be used to implement the copy of tag values from the given dcmTree to the fields.
virtual std::string	checkConsistency () const
	Checks for invalid parameters; return textual description on error, or empty string on success.
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.

Protected Member Functions
void	_addFieldPointer (Field *field)
Protected Member Functions inherited from ml::FieldAddOnBase
void	_addFieldPointer (Field *field)

Protected Attributes
DCMTree::Const_TreePtr	_inputDicomTree

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

Definition at line 28 of file mlDicomModifyModuleFieldAddOnBase.h.

Constructor & Destructor Documentation

DicomModifyModuleFieldAddOnBase()

ml::DicomModifyModuleFieldAddOnBase::DicomModifyModuleFieldAddOnBase	(	FieldContainer &	fieldContainer,
		const std::string &	dicomModuleName,
		bool	createInputModifyTagsPluginBaseConnectorField = false,
		bool	createOutputModifyTagsPluginBaseConnectorField = false )

Member Function Documentation

_addFieldPointer()

void ml::DicomModifyModuleFieldAddOnBase::_addFieldPointer ( Field * field )

protected

addFields()

virtual void ml::DicomModifyModuleFieldAddOnBase::addFields ( )

overridevirtual

Add fields to field container of the FieldAddOn.

Reimplemented from ml::DicomModifyFieldAddOnBase.

Reimplemented in ml::DicomModifyApprovalModuleFieldAddOn, ml::DicomModifyCalculatedDoseReferenceRecordModuleFieldAddOn, ml::DicomModifyCineModuleFieldAddOn, ml::DicomModifyClinicalTrialSeriesModuleFieldAddOn, ml::DicomModifyClinicalTrialStudyModuleFieldAddOn, ml::DicomModifyClinicalTrialSubjectModuleFieldAddOn, ml::DicomModifyContrastBolusModuleFieldAddOn, ml::DicomModifyDeviceModuleFieldAddOn, ml::DicomModifyFrameOfReferenceModuleFieldAddOn, ml::DicomModifyGeneralEquipmentModuleFieldAddOn, ml::DicomModifyGeneralImageModuleFieldAddOn, ml::DicomModifyGeneralStudyModuleFieldAddOn, ml::DicomModifyImagePixelModuleFieldAddOn, ml::DicomModifyImagePlaneModuleFieldAddOn, ml::DicomModifyMeasuredDoseReferenceRecordModuleFieldAddOn, ml::DicomModifyModalityLUTModuleFieldAddOn, ml::DicomModifyMultiFrameModuleFieldAddOn, ml::DicomModifyMultiFrameOverlayModuleFieldAddOn, ml::DicomModifyOverlayPlaneModuleFieldAddOn, ml::DicomModifyPatientModuleFieldAddOn, ml::DicomModifyPatientStudyModuleFieldAddOn, ml::DicomModifyROIContourModuleFieldAddOn, ml::DicomModifyRTBeamsModuleFieldAddOn, ml::DicomModifyRTBrachyApplicationSetupsModuleFieldAddOn, ml::DicomModifyRTDoseModuleFieldAddOn, ml::DicomModifyRTDoseROIModuleFieldAddOn, ml::DicomModifyRTDVHModuleFieldAddOn, ml::DicomModifyRTFractionSchemeModuleFieldAddOn, ml::DicomModifyRTGeneralPlanModuleFieldAddOn, ml::DicomModifyRTGeneralTreatmentRecordModuleFieldAddOn, ml::DicomModifyRTImageModuleFieldAddOn, ml::DicomModifyRTIonBeamsModuleFieldAddOn, ml::DicomModifyRTIonBeamsSessionRecordModuleFieldAddOn, ml::DicomModifyRTIonToleranceTablesModuleFieldAddOn, ml::DicomModifyRTPatientSetupModuleFieldAddOn, ml::DicomModifyRTPrescriptionModuleFieldAddOn, ml::DicomModifyRTROIObservationsModuleFieldAddOn, ml::DicomModifyRTSeriesModuleFieldAddOn, ml::DicomModifyRTToleranceTablesModuleFieldAddOn, ml::DicomModifyRTTreatmentMachineRecordModuleFieldAddOn, ml::DicomModifyRTTreatmentSummaryRecordModuleFieldAddOn, ml::DicomModifySOPCommonModuleFieldAddOn, ml::DicomModifyStructureSetModuleFieldAddOn, and ml::DicomModifyVOILUTModuleFieldAddOn.

handleFieldChanges()

virtual FieldAddOnBase::FieldChangeState ml::DicomModifyModuleFieldAddOnBase::handleFieldChanges ( Field * field )

overridevirtual

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

Reimplemented from ml::DicomModifyFieldAddOnBase.

setInputDicomTreeField()

void ml::DicomModifyModuleFieldAddOnBase::setInputDicomTreeField

(

BaseField *

field

)

Member Data Documentation

_inputDicomTree

DCMTree::Const_TreePtr ml::DicomModifyModuleFieldAddOnBase::_inputDicomTree

protected

Definition at line 43 of file mlDicomModifyModuleFieldAddOnBase.h.

---

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

• FMEwork/ReleaseMeVis/Sources/Shared/MLDicomModifyFieldAddOns/mlDicomModifyModuleFieldAddOnBase.h