MeVisLab Toolbox Reference
MLDICOMCachedIODCMTreeLoaderPlugin Class Reference

Base class for plugins which support loading of DICOM trees (this class already implements basic file loading). More...

#include <mlDICOMCachedIODCMTreeLoaderPlugin.h>

Public Member Functions

 MLDICOMCachedIODCMTreeLoaderPlugin ()
 Default constructor. More...
 
virtual ~MLDICOMCachedIODCMTreeLoaderPlugin ()
 Destructor. More...
 
virtual MLErrorCode loadDCMTree (const ml::DICOMCachedIOFileHandle &fileHandle, DCMTree::TreePtr &treePtr, ml::DicomMessageCollector &dcmMsgCollector) const
 Loads the given DICOM tree specified by fileName into treePtr. More...
 

Detailed Description

Base class for plugins which support loading of DICOM trees (this class already implements basic file loading).


Definition at line 33 of file mlDICOMCachedIODCMTreeLoaderPlugin.h.

Constructor & Destructor Documentation

◆ MLDICOMCachedIODCMTreeLoaderPlugin()

MLDICOMCachedIODCMTreeLoaderPlugin::MLDICOMCachedIODCMTreeLoaderPlugin ( )

Default constructor.

◆ ~MLDICOMCachedIODCMTreeLoaderPlugin()

virtual MLDICOMCachedIODCMTreeLoaderPlugin::~MLDICOMCachedIODCMTreeLoaderPlugin ( )
virtual

Destructor.

Member Function Documentation

◆ loadDCMTree()

virtual MLErrorCode MLDICOMCachedIODCMTreeLoaderPlugin::loadDCMTree ( const ml::DICOMCachedIOFileHandle fileHandle,
DCMTree::TreePtr treePtr,
ml::DicomMessageCollector dcmMsgCollector 
) const
virtual

Loads the given DICOM tree specified by fileName into treePtr.

Parameters
fileHandleFull path to DICOM tree file to be loaded.
treePtrThe loaded and returned DICOM tree, reset to nullptr if load fails.
dcmMsgCollectorCollects error, info and issue messages (typically related to a handle).
Returns
ML_RESULT_OK if a tree could be loaded (with or without issues), otherwise a code describing the error.

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