ml::DcmtkBase Class Reference
Base object class for Base objects that wrap dcmtk objects. More...
#include <mlDcmtkBase.h>
Public Member Functions | |
| DcmtkBase () | |
| Default Constructor. | |
| DcmtkBase (const DcmFileFormat &dcmFile) | |
| Constructor. Gets a reference to the DICOM file containing the dcmtk object to be wrapped. | |
| DcmtkBase (DcmFileFormat *dcmFilePtr) | |
| Constructor. Gets a pointer to the DICOM file containing the dcmtk object to be wrapped. | |
| virtual | ~DcmtkBase () |
| Virtual Destructor. | |
| virtual bool | getInfoString (std::ostringstream &outString, std::string *errVal=NULL) |
| bool | referencedDCMObjects () const |
| Return a vector containing information about the dicom objects referenced by wrapped dcmtk object. | |
| const DcmtkObjectReferenceInfoConstVector & | getReferencedDCMObjectInfos () const |
| DcmFileFormatPtr & | getDcmFile () |
| virtual bool | isValid () |
| Return true if wrapped Dcmtk object is valid. | |
Protected Member Functions | |
| void | _addDCMObjectInfo (const DcmtkObjectReferenceInfo &dcmObjectRefInfo) |
Protected Attributes | |
| DcmtkObjectReferenceInfoConstVector | _referencedDCMObjectInfos |
| A vector containing information objects of all references to other dicom objects. | |
| DcmFileFormatPtr | _dcmFilePtr |
| A Boost Pointer to the DICOM file containing the dcmtk object which is wrapped by the base object. | |
Detailed Description
Base object class for Base objects that wrap dcmtk objects.Definition at line 32 of file mlDcmtkBase.h.
Constructor & Destructor Documentation
| ml::DcmtkBase::DcmtkBase | ( | ) | [inline] |
| ml::DcmtkBase::DcmtkBase | ( | const DcmFileFormat & | dcmFile | ) | [inline] |
Constructor. Gets a reference to the DICOM file containing the dcmtk object to be wrapped.
Definition at line 40 of file mlDcmtkBase.h.
| ml::DcmtkBase::DcmtkBase | ( | DcmFileFormat * | dcmFilePtr | ) | [inline] |
Constructor. Gets a pointer to the DICOM file containing the dcmtk object to be wrapped.
Definition at line 43 of file mlDcmtkBase.h.
| virtual ml::DcmtkBase::~DcmtkBase | ( | ) | [inline, virtual] |
Member Function Documentation
| void ml::DcmtkBase::_addDCMObjectInfo | ( | const DcmtkObjectReferenceInfo & | dcmObjectRefInfo | ) | [protected] |
| DcmFileFormatPtr& ml::DcmtkBase::getDcmFile | ( | ) | [inline] |
Definition at line 59 of file mlDcmtkBase.h.
| virtual bool ml::DcmtkBase::getInfoString | ( | std::ostringstream & | outString, | |
| std::string * | errVal = NULL | |||
| ) | [virtual] |
| const DcmtkObjectReferenceInfoConstVector& ml::DcmtkBase::getReferencedDCMObjectInfos | ( | ) | const [inline] |
Definition at line 56 of file mlDcmtkBase.h.
| virtual bool ml::DcmtkBase::isValid | ( | void | ) | [inline, virtual] |
Return true if wrapped Dcmtk object is valid.
Reimplemented in ml::DRTDoseIODBase, ml::DRTImageIODBase, ml::DRTIonBeamsTreatmentRecordIODBase, ml::DRTIonPlanIODBase, ml::DRTPlanIODBase, ml::DRTStructureSetIODBase, ml::DRTTreatmentSummaryRecordIODBase, ml::PresentationState, and ml::SRDoc.
Definition at line 62 of file mlDcmtkBase.h.
| bool ml::DcmtkBase::referencedDCMObjects | ( | ) | const [inline] |
Return a vector containing information about the dicom objects referenced by wrapped dcmtk object.
Definition at line 53 of file mlDcmtkBase.h.
Member Data Documentation
DcmFileFormatPtr ml::DcmtkBase::_dcmFilePtr [protected] |
A Boost Pointer to the DICOM file containing the dcmtk object which is wrapped by the base object.
Definition at line 70 of file mlDcmtkBase.h.
A vector containing information objects of all references to other dicom objects.
Definition at line 67 of file mlDcmtkBase.h.
The documentation for this class was generated from the following file:
- FMEwork/Release/Sources/Shared/MLDcmtkBaseObjects/mlDcmtkBase.h
