ml::DcmIODToMLConverterAbstract< DcmIODBase, DcmIOD > Class Template Reference

Templated base class for classes that convert a DcmIODBase object to ML. More...

#include <mlDcmIODToMLConverterAbstract.h>

List of all members.

Public Types
typedef std::map < DcmModuleType, DcmModuleBaseOpInterface < DcmIODBase > * >	moduleInterfaceMap
	Maps a DcmModuleType enum to DcmModuleBaseOpInterface pointer.
Public Member Functions
	DcmIODToMLConverterAbstract ()
	Constructor.
virtual	~DcmIODToMLConverterAbstract ()
	Destructor.
virtual void	addFields (FieldContainer &fieldContainer)
	Delegates the addFields method call to all internal DcmModuleBaseOpInterface instances.
virtual void	handleBaseObjectChange (DcmIODBase *baseObj)
	Delegates the handleBaseObjectChange method call to all internal DcmModuleBaseOpInterface instances.
virtual void	handleNotification (Field *field)
	Handle Field Notification.
void	createDcmModuleInterfaces (DcmModuleType *dcmModuleArr, MLuint numDcmModules)
	Factory method that generates DcmModuleBaseOpInterface instances accoriding to given dcmModuleArr.
void	createAllDcmModuleInterfaces ()
	Convenience factory method to generate all DcmModule this DcmIOD contains.
DcmIODBase *	getBaseObject ()
	Return pointer to the internal DcmIODBase object.
Protected Member Functions
virtual DcmModuleBaseOpInterface < DcmIODBase > *	_createDcmIODBaseOp (DcmModuleType dcmModuleType)=0
	Factory method that implements the actual instantiation of DcmModuleBaseOpInterfaces.
Protected Attributes
moduleInterfaceMap	_moduleInterfaces
	The map containing all created DcmModuleBaseOpInterface instances.
DcmModuleType *	_allowedModuleTypes
	An array containing all DcmModuleType enums this DcmIOD can consist of.
MLuint	_allowedModuleTypesSize
	Number of elements in * _allowedModuleTypes.
BaseField *	_dcmBaseFld
	Input BaseField that accepts a Base object of type DcmIODBase.
DcmIODBase *	_dcmBaseObject
	The Dcmtk Base object carried by _dcmBaseFld.

---

Detailed Description

template<typename DcmIODBase, typename DcmIOD>
class ml::DcmIODToMLConverterAbstract< DcmIODBase, DcmIOD >

Templated base class for classes that convert a DcmIODBase object to ML.

It provides factory methods to generate DcmModuleBaseOpInterfaces for a specific IOD. I.e. a client can choose which DcmModules of given DcmIOD it wants to convert.

Definition at line 95 of file mlDcmIODToMLConverterAbstract.h.

---

Member Typedef Documentation

template<typename DcmIODBase, typename DcmIOD>

typedef std::map<DcmModuleType, DcmModuleBaseOpInterface<DcmIODBase>*> ml::DcmIODToMLConverterAbstract< DcmIODBase, DcmIOD >::moduleInterfaceMap

Maps a DcmModuleType enum to DcmModuleBaseOpInterface pointer.

Definition at line 100 of file mlDcmIODToMLConverterAbstract.h.

---

Constructor & Destructor Documentation

template<typename DcmIODBase, typename DcmIOD>

ml::DcmIODToMLConverterAbstract< DcmIODBase, DcmIOD >::DcmIODToMLConverterAbstract

(

)

[inline]

Constructor.

Definition at line 103 of file mlDcmIODToMLConverterAbstract.h.

template<typename DcmIODBase, typename DcmIOD>

virtual ml::DcmIODToMLConverterAbstract< DcmIODBase, DcmIOD >::~DcmIODToMLConverterAbstract

(

)

[inline, virtual]

Destructor.

Definition at line 106 of file mlDcmIODToMLConverterAbstract.h.

---

Member Function Documentation

template<typename DcmIODBase, typename DcmIOD>

virtual DcmModuleBaseOpInterface<DcmIODBase>* ml::DcmIODToMLConverterAbstract< DcmIODBase, DcmIOD >::_createDcmIODBaseOp

(

DcmModuleType

dcmModuleType

)

[protected, pure virtual]

Factory method that implements the actual instantiation of DcmModuleBaseOpInterfaces.

Implemented in ml::DRTDoseIODToMLConverter, ml::DRTImageIODToMLConverter, ml::DRTIonBeamsTreatmentRecordIODToMLConverter, ml::DRTIonPlanIODToMLConverter, ml::DRTPlanIODToMLConverter, ml::DRTStructureSetIODToMLConverter, and ml::DRTTreatmentSummaryRecordIODToMLConverter.

template<typename DcmIODBase, typename DcmIOD>

virtual void ml::DcmIODToMLConverterAbstract< DcmIODBase, DcmIOD >::addFields

(

FieldContainer &

fieldContainer

)

[inline, virtual]

Delegates the addFields method call to all internal DcmModuleBaseOpInterface instances.

Reimplemented in ml::DRTDoseIODToMLConverter, ml::DRTImageIODToMLConverter, ml::DRTIonBeamsTreatmentRecordIODToMLConverter, ml::DRTIonPlanIODToMLConverter, ml::DRTPlanIODToMLConverter, ml::DRTStructureSetIODToMLConverter, and ml::DRTTreatmentSummaryRecordIODToMLConverter.

Definition at line 115 of file mlDcmIODToMLConverterAbstract.h.

template<typename DcmIODBase, typename DcmIOD>

void ml::DcmIODToMLConverterAbstract< DcmIODBase, DcmIOD >::createAllDcmModuleInterfaces

(

)

[inline]

Convenience factory method to generate all DcmModule this DcmIOD contains.

Definition at line 155 of file mlDcmIODToMLConverterAbstract.h.

template<typename DcmIODBase, typename DcmIOD>

void ml::DcmIODToMLConverterAbstract< DcmIODBase, DcmIOD >::createDcmModuleInterfaces	(	DcmModuleType *	dcmModuleArr,
		MLuint	numDcmModules
	)			[inline]

Factory method that generates DcmModuleBaseOpInterface instances accoriding to given dcmModuleArr.

Definition at line 140 of file mlDcmIODToMLConverterAbstract.h.

template<typename DcmIODBase, typename DcmIOD>

DcmIODBase* ml::DcmIODToMLConverterAbstract< DcmIODBase, DcmIOD >::getBaseObject

(

)

[inline]

Return pointer to the internal DcmIODBase object.

Definition at line 160 of file mlDcmIODToMLConverterAbstract.h.

template<typename DcmIODBase, typename DcmIOD>

virtual void ml::DcmIODToMLConverterAbstract< DcmIODBase, DcmIOD >::handleBaseObjectChange

(

DcmIODBase *

baseObj

)

[inline, virtual]

Delegates the handleBaseObjectChange method call to all internal DcmModuleBaseOpInterface instances.

Reimplemented in ml::DRTDoseIODToMLConverter, ml::DRTImageIODToMLConverter, ml::DRTIonBeamsTreatmentRecordIODToMLConverter, ml::DRTIonPlanIODToMLConverter, ml::DRTPlanIODToMLConverter, ml::DRTStructureSetIODToMLConverter, and ml::DRTTreatmentSummaryRecordIODToMLConverter.

Definition at line 123 of file mlDcmIODToMLConverterAbstract.h.

template<typename DcmIODBase, typename DcmIOD>

virtual void ml::DcmIODToMLConverterAbstract< DcmIODBase, DcmIOD >::handleNotification

(

Field *

field

)

[inline, virtual]

Handle Field Notification.

Reimplemented in ml::DRTDoseIODToMLConverter, ml::DRTImageIODToMLConverter, ml::DRTIonBeamsTreatmentRecordIODToMLConverter, ml::DRTIonPlanIODToMLConverter, ml::DRTPlanIODToMLConverter, ml::DRTStructureSetIODToMLConverter, and ml::DRTTreatmentSummaryRecordIODToMLConverter.

Definition at line 131 of file mlDcmIODToMLConverterAbstract.h.

---

Member Data Documentation

template<typename DcmIODBase, typename DcmIOD>

DcmModuleType* ml::DcmIODToMLConverterAbstract< DcmIODBase, DcmIOD >::_allowedModuleTypes [protected]

An array containing all DcmModuleType enums this DcmIOD can consist of.

Definition at line 171 of file mlDcmIODToMLConverterAbstract.h.

template<typename DcmIODBase, typename DcmIOD>

MLuint ml::DcmIODToMLConverterAbstract< DcmIODBase, DcmIOD >::_allowedModuleTypesSize [protected]

Number of elements in * _allowedModuleTypes.

Definition at line 174 of file mlDcmIODToMLConverterAbstract.h.

template<typename DcmIODBase, typename DcmIOD>

BaseField* ml::DcmIODToMLConverterAbstract< DcmIODBase, DcmIOD >::_dcmBaseFld [protected]

Input BaseField that accepts a Base object of type DcmIODBase.

Definition at line 177 of file mlDcmIODToMLConverterAbstract.h.

template<typename DcmIODBase, typename DcmIOD>

DcmIODBase* ml::DcmIODToMLConverterAbstract< DcmIODBase, DcmIOD >::_dcmBaseObject [protected]

The Dcmtk Base object carried by _dcmBaseFld.

Definition at line 180 of file mlDcmIODToMLConverterAbstract.h.

template<typename DcmIODBase, typename DcmIOD>

moduleInterfaceMap ml::DcmIODToMLConverterAbstract< DcmIODBase, DcmIOD >::_moduleInterfaces [protected]

The map containing all created DcmModuleBaseOpInterface instances.

Definition at line 168 of file mlDcmIODToMLConverterAbstract.h.

---

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

• FMEwork/Release/Sources/Shared/MLDcmtkMLConverters/DcmIODConverters/mlDcmIODToMLConverterAbstract.h