RZDCX - Fast Strike DICOM Toolkit  Release 2.0.7.4
IDCXDICOMDIR Interface Reference

A DICOMDIR file reader. Use the IDCXDICOMDIR Interface to read a DICOMDIR file and read the fileset records in it. Each method return a IDCXOBJIterator that can be used to go over the record of the specific type. If a matching string (or strings) is provided, then the records of that level that match the string a returned. If the matching string is empty, then all the records of that type are returned. For example, to get the complete list of all DICOM files in the fileset, simply use getSeriesLeafIterator with empty matching strings. More...

Inherits IDispatch.

Public Member Functions

HRESULT Init ([in] BSTR filePath)
 Read the DICOMDIR from file.
 
HRESULT getPatientIterator ([out, retval] IDCXOBJIterator **i)
 Get all patient records. More...
 
HRESULT getStudyIterator ([in] BSTR patientID, [out, retval] IDCXOBJIterator **i)
 Get all Study records. If patientID is not empty, get the study records of that patient. More...
 
HRESULT getSeriesIterator ([in] BSTR patientID, [in] BSTR studyInstanceUID, [out, retval] IDCXOBJIterator **i)
 Get all Series records. More...
 
HRESULT getSeriesLeafIterator ([in] BSTR patientID, [in] BSTR studyInstanceUID, [in] BSTR seriesInstanceUID, [out, retval] IDCXOBJIterator **i)
 Get all Series leafs (instances/files and other nodes) More...
 
HRESULT ScanAndCreate ([in] BSTR root, [in] APPLICATION_PROFILE app_profile, [in] BSTR filesetDescriptor, [in] VARIANT_BOOL strict)
 

Detailed Description

A DICOMDIR file reader. Use the IDCXDICOMDIR Interface to read a DICOMDIR file and read the fileset records in it. Each method return a IDCXOBJIterator that can be used to go over the record of the specific type. If a matching string (or strings) is provided, then the records of that level that match the string a returned. If the matching string is empty, then all the records of that type are returned. For example, to get the complete list of all DICOM files in the fileset, simply use getSeriesLeafIterator with empty matching strings.

Member Function Documentation

◆ getPatientIterator()

HRESULT IDCXDICOMDIR::getPatientIterator ( [out, retval] IDCXOBJIterator **  i)

Get all patient records.

Parameters
iAn object iterator holding one object per record

◆ getSeriesIterator()

HRESULT IDCXDICOMDIR::getSeriesIterator ( [in] BSTR  patientID,
[in] BSTR  studyInstanceUID,
[out, retval] IDCXOBJIterator **  i 
)

Get all Series records.

Parameters
patientIDOptional patient ID.
studyInstanceUIDOptional Study Instance UID.
iAn object iterator holding one object per record

◆ getSeriesLeafIterator()

HRESULT IDCXDICOMDIR::getSeriesLeafIterator ( [in] BSTR  patientID,
[in] BSTR  studyInstanceUID,
[in] BSTR  seriesInstanceUID,
[out, retval] IDCXOBJIterator **  i 
)

Get all Series leafs (instances/files and other nodes)

Parameters
patientIDOptional patient ID
studyInstanceUIDOptional Study Instance UID
seriesInstanceUIDOptional Series Instance UID
iAn object iterator holding one object per record

◆ getStudyIterator()

HRESULT IDCXDICOMDIR::getStudyIterator ( [in] BSTR  patientID,
[out, retval] IDCXOBJIterator **  i 
)

Get all Study records. If patientID is not empty, get the study records of that patient.

Parameters
patientIDOptional patient ID. If empty will return all records
iAn object iterator holding one object per record

◆ ScanAndCreate()

HRESULT IDCXDICOMDIR::ScanAndCreate ( [in] BSTR  root,
[in] APPLICATION_PROFILE  app_profile,
[in] BSTR  filesetDescriptor,
[in] VARIANT_BOOL  strict 
)
Parameters
rootThe root folder to scan and the path to where to store the DICOMDIR file
app_profileThe application profile to use
filesetDescriptorA descriptor for the fileset
strictIf set to true, all validations according to the profile selected are made. Othewise DICOMDIR file is created even if it's not according to all astandard rules.