fw4spl
fwGdcmIO::writer::ie::Study Class Reference

Study Information Entity class. More...

#include <Study.hpp>

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

Public Member Functions

FWGDCMIO_API Study (const std::shared_ptr< ::gdcm::Writer > &writer, const std::shared_ptr< ::fwGdcmIO::container::DicomInstance > &instance, const ::fwMedData::Study::csptr &study, const ::fwLog::Logger::sptr &logger=nullptr, ProgressCallback progress=nullptr, CancelRequestedCallback cancel=nullptr)
 Constructor. More...
 
virtual FWGDCMIO_API ~Study ()
 Destructor.
 
virtual FWGDCMIO_API void writeGeneralStudyModule ()
 Write General Study Module tags. More...
 
virtual FWGDCMIO_API void writePatientStudyModule ()
 Write Patient Study Module tags. More...
 
- Public Member Functions inherited from fwGdcmIO::writer::ie::InformationEntity< ::fwMedData::Study >
FWGDCMIO_API InformationEntity (const std::shared_ptr< ::gdcm::Writer > &writer, const std::shared_ptr< ::fwGdcmIO::container::DicomInstance > &instance, const std::shared_ptr< const ::fwMedData::Study > &object, const ::fwLog::Logger::sptr &logger=nullptr, ProgressCallback progress=nullptr, CancelRequestedCallback cancel=nullptr)
 Constructor. More...
 
virtual FWGDCMIO_API ~InformationEntity ()
 Destructor.
 

Additional Inherited Members

- Public Types inherited from fwGdcmIO::writer::ie::InformationEntity< ::fwMedData::Study >
typedef std::function< void(std::uint64_t) > ProgressCallback
 
typedef std::function< bool() > CancelRequestedCallback
 
- Protected Attributes inherited from fwGdcmIO::writer::ie::InformationEntity< ::fwMedData::Study >
std::shared_ptr< ::gdcm::Writer > m_writer
 GDCM Writer.
 
std::shared_ptr< ::fwGdcmIO::container::DicomInstancem_instance
 DICOM Instance.
 
std::shared_ptr< const ::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/writer/ie/Study.hpp.

Constructor & Destructor Documentation

fwGdcmIO::writer::ie::Study::Study ( const std::shared_ptr< ::gdcm::Writer > &  writer,
const std::shared_ptr< ::fwGdcmIO::container::DicomInstance > &  instance,
const ::fwMedData::Study::csptr &  study,
const ::fwLog::Logger::sptr &  logger = nullptr,
ProgressCallback  progress = nullptr,
CancelRequestedCallback  cancel = nullptr 
)

Constructor.

Parameters
[in]writerGDCM writer that must be enriched
[in]instanceDICOM instance used to share information between modules
[in]studyStudy data
[in]loggerLogger
[in]progressProgress callback
[in]cancelCancel requested callback

Definition at line 22 of file io/fwGdcmIO/src/fwGdcmIO/writer/ie/Study.cpp.

Member Function Documentation

void fwGdcmIO::writer::ie::Study::writeGeneralStudyModule ( )
virtual
void fwGdcmIO::writer::ie::Study::writePatientStudyModule ( )
virtual

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