ml::SRDoc Class Reference

Base object class for passing DSRDocuments between MeVisLab modules. More...

#include <mlSRDocBase.h>

Inheritance diagram for ml::SRDoc:

List of all members.

Public Member Functions
	SRDoc ()
	Default Constructor.
	SRDoc (const std::string &dcmFileName)
	Constructor. Gets a reference to the name of the DICOM file containing the sr document object to be wrapped.
	SRDoc (DcmFileFormat &dcmFile)
	Constructor. Gets a reference to the DICOM file containing the sr document object to be wrapped.
	SRDoc (DcmFileFormat *dcmFilePtr)
	Constructor. Gets a pointer to the DICOM file containing the sr document object to be wrapped.
virtual	~SRDoc ()
	Virtual Destructor.
void	setSRDocumentIOD (DSRDocumentPtr rtDosePtr)
	Set the SRDoc dcmtk object and collect all referenced dcmtk objects.
DSRDocumentPtr	getSRDocumentIOD ()
	Get the SRDoc dcmtk object.
bool	isValid ()
	Return true if wrapped SRDocumentIOD object is valid.

---

Detailed Description

Base object class for passing DSRDocuments between MeVisLab modules.

Definition at line 34 of file mlSRDocBase.h.

---

Constructor & Destructor Documentation

ml::SRDoc::SRDoc

(

)

[inline]

Default Constructor.

Definition at line 39 of file mlSRDocBase.h.

ml::SRDoc::SRDoc

(

const std::string &

dcmFileName

)

Constructor. Gets a reference to the name of the DICOM file containing the sr document object to be wrapped.

ml::SRDoc::SRDoc

(

DcmFileFormat &

dcmFile

)

Constructor. Gets a reference to the DICOM file containing the sr document object to be wrapped.

ml::SRDoc::SRDoc

(

DcmFileFormat *

dcmFilePtr

)

Constructor. Gets a pointer to the DICOM file containing the sr document object to be wrapped.

virtual ml::SRDoc::~SRDoc

(

)

[inline, virtual]

Virtual Destructor.

Definition at line 51 of file mlSRDocBase.h.

---

Member Function Documentation

DSRDocumentPtr ml::SRDoc::getSRDocumentIOD

(

)

[inline]

Get the SRDoc dcmtk object.

Definition at line 57 of file mlSRDocBase.h.

bool ml::SRDoc::isValid

(

void

)

[inline, virtual]

Return true if wrapped SRDocumentIOD object is valid.

Reimplemented from ml::DcmtkBase.

Definition at line 60 of file mlSRDocBase.h.

void ml::SRDoc::setSRDocumentIOD

(

DSRDocumentPtr

rtDosePtr

)

Set the SRDoc dcmtk object and collect all referenced dcmtk objects.

---

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

• FMEwork/Release/Sources/Shared/MLDcmtkBaseObjects/mlSRDocBase.h