fw4spl
fwGdcmIO::writer::ie::Document Class Reference

Document Information Entity class. More...

#include <Document.hpp>

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

Public Member Functions

FWGDCMIO_API Document (const std::shared_ptr< ::gdcm::Writer > &writer, const std::shared_ptr< ::fwGdcmIO::container::DicomInstance > &instance, const ::fwData::Image::csptr &image, bool use3DSR=false, const ::fwLog::Logger::sptr &logger=nullptr, ProgressCallback progress=nullptr, CancelRequestedCallback cancel=nullptr)
 Constructor. More...
 
virtual FWGDCMIO_API ~Document ()
 Destructor.
 
virtual FWGDCMIO_API void writeSRDocumentGeneralModule ()
 Write SR Document General Module tags. More...
 
virtual FWGDCMIO_API void writeSRDocumentContentModule ()
 Write SR Document Content Module tags. More...
 
FWGDCMIO_API void writeSOPCommonModule ()
 Write SOP Common Module tags. More...
 
- Public Member Functions inherited from fwGdcmIO::writer::ie::InformationEntity< ::fwData::Image >
FWGDCMIO_API InformationEntity (const std::shared_ptr< ::gdcm::Writer > &writer, const std::shared_ptr< ::fwGdcmIO::container::DicomInstance > &instance, const std::shared_ptr< const ::fwData::Image > &object, const ::fwLog::Logger::sptr &logger=nullptr, ProgressCallback progress=nullptr, CancelRequestedCallback cancel=nullptr)
 Constructor. More...
 
virtual FWGDCMIO_API ~InformationEntity ()
 Destructor.
 

Protected Member Functions

void writePertinentOtherEvidenceSequence ()
 Write Pertinent Other Evidence Sequence (0040,A385)
 

Protected Attributes

bool m_use3DSR
 True if we must use 3DSR.
 
- Protected Attributes inherited from fwGdcmIO::writer::ie::InformationEntity< ::fwData::Image >
std::shared_ptr< ::gdcm::Writer > m_writer
 GDCM Writer.
 
std::shared_ptr< ::fwGdcmIO::container::DicomInstancem_instance
 DICOM Instance.
 
std::shared_ptr< const ::fwData::Imagem_object
 FW4SPL Object.
 
::fwLog::Logger::sptr m_logger
 Logger.
 
ProgressCallback m_progressCallback
 Progress callback for jobs.
 
CancelRequestedCallback m_cancelRequestedCallback
 Cancel information for jobs.
 

Additional Inherited Members

- Public Types inherited from fwGdcmIO::writer::ie::InformationEntity< ::fwData::Image >
typedef std::function< void(std::uint64_t) > ProgressCallback
 
typedef std::function< bool() > CancelRequestedCallback
 

Detailed Description

Document Information Entity class.

Definition at line 24 of file writer/ie/Document.hpp.

Constructor & Destructor Documentation

fwGdcmIO::writer::ie::Document::Document ( const std::shared_ptr< ::gdcm::Writer > &  writer,
const std::shared_ptr< ::fwGdcmIO::container::DicomInstance > &  instance,
const ::fwData::Image::csptr &  image,
bool  use3DSR = false,
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]imageImage data
[in]loggerLogger
[in]progressProgress callback
[in]cancelCancel requested callback

Definition at line 37 of file writer/ie/Document.cpp.

Member Function Documentation

void fwGdcmIO::writer::ie::Document::writeSOPCommonModule ( )

Write SOP Common Module tags.

See also
PS 3.3 C.12.1

Definition at line 164 of file writer/ie/Document.cpp.

References m_use3DSR, and fwGdcmIO::writer::ie::InformationEntity< ::fwData::Image >::m_writer.

void fwGdcmIO::writer::ie::Document::writeSRDocumentContentModule ( )
virtual

Write SR Document Content Module tags.

See also
PS 3.3 C.17.3

Definition at line 148 of file writer/ie/Document.cpp.

References fwGdcmIO::writer::tid::MeasurementReport::createRootNode(), fwGdcmIO::writer::ie::InformationEntity< ::fwData::Image >::m_instance, fwGdcmIO::writer::ie::InformationEntity< ::fwData::Image >::m_object, m_use3DSR, fwGdcmIO::writer::ie::InformationEntity< ::fwData::Image >::m_writer, and SPTR.

+ Here is the call graph for this function:

void fwGdcmIO::writer::ie::Document::writeSRDocumentGeneralModule ( )
virtual

Write SR Document General Module tags.

See also
PS 3.3 C.17.2

Definition at line 57 of file writer/ie/Document.cpp.

References fwGdcmIO::writer::ie::InformationEntity< ::fwData::Image >::m_writer, and writePertinentOtherEvidenceSequence().

+ Here is the call graph for this function:


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