fwGdcmIO::reader::iod::InformationObjectDefinition Class Reference

InformationObjectDefinition base class used to read DICOM IODs. More...

#include <InformationObjectDefinition.hpp>

Inheritance diagram for fwGdcmIO::reader::iod::InformationObjectDefinition:

Public Types
typedef std::function< void(std::uint64_t) >	ProgressCallback
typedef std::function< bool() >	CancelRequestedCallback

Public Member Functions
FWGDCMIO_API	InformationObjectDefinition (const ::fwMedData::DicomSeries::csptr &dicomSeries, const std::shared_ptr< ::fwGdcmIO::container::DicomInstance > &instance, const ::fwLog::Logger::sptr &logger=nullptr, ProgressCallback progress=nullptr, CancelRequestedCallback cancel=nullptr)
	Constructor. More...
virtual FWGDCMIO_API	~InformationObjectDefinition ()
	Destructor.
virtual FWGDCMIO_API void	read (::fwMedData::Series::sptr series)=0 throw (::fwGdcmIO::exception::Failed)
	Read a DICOM File. More...

Protected Attributes
std::shared_ptr< ::fwGdcmIO::container::DicomInstance >	m_instance
	DICOM Instance.
::fwMedData::DicomSeries::csptr	m_dicomSeries
	Dicom Series.
::fwLog::Logger::sptr	m_logger
	Logger.
ProgressCallback	m_progressCallback
	Progress callback for jobs.
CancelRequestedCallback	m_cancelRequestedCallback
	Cancel information for jobs.

Detailed Description

InformationObjectDefinition base class used to read DICOM IODs.

Definition at line 31 of file reader/iod/InformationObjectDefinition.hpp.

Constructor & Destructor Documentation

fwGdcmIO::reader::iod::InformationObjectDefinition::InformationObjectDefinition	(	const ::fwMedData::DicomSeries::csptr &	dicomSeries,
		const std::shared_ptr< ::fwGdcmIO::container::DicomInstance > &	instance,
		const ::fwLog::Logger::sptr &	logger = nullptr,
		ProgressCallback	progress = nullptr,
		CancelRequestedCallback	cancel = nullptr
	)

Constructor.

Parameters

[in]	dicomSeries	DicomSeries
[in]	instance	Instance
[in]	logger	Logger
[in]	progress	Progress callback
[in]	cancel	Cancel requested callback

Definition at line 18 of file reader/iod/InformationObjectDefinition.cpp.

References SLM_ASSERT.

Member Function Documentation

virtual FWGDCMIO_API void fwGdcmIO::reader::iod::InformationObjectDefinition::read ( ::fwMedData::Series::sptr  series ) throw ( ::fwGdcmIO::exception::Failed )

pure virtual

Read a DICOM File.

Parameters

[in,out]

series

Series that must be enriched

Implemented in fwGdcmIO::reader::iod::SurfaceSegmentationIOD, fwGdcmIO::reader::iod::CTMRImageIOD, fwGdcmIO::reader::iod::SpatialFiducialsIOD, and fwGdcmIO::reader::iod::ComprehensiveSRIOD.

---

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

• reader/iod/InformationObjectDefinition.hpp
• reader/iod/InformationObjectDefinition.cpp