fw4spl
fwGdcmIO::reader::ie::Study Class Reference

Study Information Entity class. More...

#include <Study.hpp>

+ Inheritance diagram for fwGdcmIO::reader::ie::Study:
+ Collaboration diagram for fwGdcmIO::reader::ie::Study:

Public Member Functions

FWGDCMIO_API Study (const std::shared_ptr< const ::fwMedData::DicomSeries > &dicomSeries, const std::shared_ptr< ::gdcm::Reader > &reader, const std::shared_ptr< ::fwGdcmIO::container::DicomInstance > &instance, const ::fwMedData::Study::sptr &study, const ::fwLog::Logger::sptr &logger=nullptr, ProgressCallback progress=nullptr, CancelRequestedCallback cancel=nullptr)
 Constructor. More...
 
virtual FWGDCMIO_API ~Study ()
 Destructor.
 
virtual FWGDCMIO_API void readGeneralStudyModule ()
 Read General Study Module tags. More...
 
virtual FWGDCMIO_API void readPatientStudyModule ()
 Read Patient Study Module tags. More...
 
- Public Member Functions inherited from fwGdcmIO::reader::ie::InformationEntity< ::fwMedData::Study >
FWGDCMIO_API InformationEntity (const std::shared_ptr< const ::fwMedData::DicomSeries > &dicomSeries, const std::shared_ptr< ::gdcm::Reader > &reader, const std::shared_ptr< ::fwGdcmIO::container::DicomInstance > &instance, const std::shared_ptr< ::fwMedData::Study > &object, const ::fwLog::Logger::sptr &logger=nullptr, const ProgressCallback progress=nullptr, CancelRequestedCallback cancel=nullptr)
 Constructor. More...
 
virtual FWGDCMIO_API ~InformationEntity ()
 Destructor.
 

Additional Inherited Members

- Public Types inherited from fwGdcmIO::reader::ie::InformationEntity< ::fwMedData::Study >
typedef std::function< void(std::uint64_t) > ProgressCallback
 
typedef std::function< bool() > CancelRequestedCallback
 
- Protected Attributes inherited from fwGdcmIO::reader::ie::InformationEntity< ::fwMedData::Study >
std::shared_ptr< const ::fwMedData::DicomSeriesm_dicomSeries
 Dicom Series.
 
std::shared_ptr< ::gdcm::Reader > m_reader
 GDCM Reader.
 
std::shared_ptr< ::fwGdcmIO::container::DicomInstancem_instance
 DICOM Instance.
 
std::shared_ptr< ::fwMedData::Studym_object
 FW4SPL Object.
 
::fwLog::Logger::sptr m_logger
 Logger.
 
ProgressCallback m_progressCallback
 Progress callback for jobs.
 
CancelRequestedCallback m_cancelRequestedCallback
 Cancel information for jobs.
 

Detailed Description

Study Information Entity class.

Definition at line 23 of file io/fwGdcmIO/include/fwGdcmIO/reader/ie/Study.hpp.

Constructor & Destructor Documentation

FWGDCMIO_API fwGdcmIO::reader::ie::Study::Study ( const std::shared_ptr< const ::fwMedData::DicomSeries > &  dicomSeries,
const std::shared_ptr< ::gdcm::Reader > &  reader,
const std::shared_ptr< ::fwGdcmIO::container::DicomInstance > &  instance,
const ::fwMedData::Study::sptr &  study,
const ::fwLog::Logger::sptr &  logger = nullptr,
ProgressCallback  progress = nullptr,
CancelRequestedCallback  cancel = nullptr 
)

Constructor.

Parameters
[in]dicomSeriesDicomSeries used to access computed tag values.
[in]readerGDCM reader that must be used to read study.
[in]instanceDICOM instance used to share informations between modules
[in]studyStudy data
[in]loggerLogger
[in]progressProgress callback
[in]cancelCancel requested callback

Member Function Documentation

void fwGdcmIO::reader::ie::Study::readGeneralStudyModule ( )
virtual

Read General Study Module tags.

See also
PS 3.3 C.7.2.1

Definition at line 43 of file io/fwGdcmIO/src/fwGdcmIO/reader/ie/Study.cpp.

void fwGdcmIO::reader::ie::Study::readPatientStudyModule ( )
virtual

Read Patient Study Module tags.

See also
PS 3.3 C.7.2.2

Definition at line 80 of file io/fwGdcmIO/src/fwGdcmIO/reader/ie/Study.cpp.


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