Base class for all object writers. More...

#include <IObjectWriter.hpp>

Inheritance diagram for fwDataIO::writer::IObjectWriter:

Collaboration diagram for fwDataIO::writer::IObjectWriter:

Classes
class	Registrar
	Class used to register a class factory in factory registry. This class defines also the object factory ( 'create' ) More...

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

typedef std::function< void() >	CancelCallback

typedef ::fwDataIO::writer::factory::Key	Key

Public Member Functions
virtual bool	isA (const std::string &type) const override

virtual FWDATAIO_API void	write ()=0
	Defines an writer interface. More...

virtual FWDATAIO_API void	setLocation (const ::fwData::location::ILocation::sptr location)
	m_location setter. More...

virtual FWDATAIO_API::fwData::location::ILocation::sptr	getLocation ()
	m_location getter. More...

virtual FWDATAIO_API void	setObject (::fwTools::Object::csptr object)
	m_object setter. More...

virtual FWDATAIO_API::fwTools::Object::csptr	getObject () const
	m_object getter. More...

virtual FWDATAIO_API std::string	extension ()=0
	Return the default filename extension can be dynamic. More...

virtual FWDATAIO_API void	cancel ()
	Requests writer abortion.

virtual std::shared_ptr< ::fwJobs::IJob >	getJob () const
	Returns the internal job, nullptr by default.

Public Member Functions inherited from fwCore::BaseObject

Static Public Member Functions
static bool	isTypeOf (const std::string &type)

Static Public Member Functions inherited from fwCore::BaseObject
static bool	isTypeOf (const std::string &type)

static const std::string &	leafClassname ()
	return object's classname without its namespace, i.e. BaseObject

static const std::string &	classname ()
	return object's classname without its namespace, i.e. BaseObject

Protected Member Functions
FWDATAIO_API	IObjectWriter ()
	Constructor. Do nothing.

virtual FWDATAIO_API	~IObjectWriter ()
	Destructor. Do nothing.

Protected Attributes
::fwTools::Object::cwptr	m_object
	Object write on filesystem by the process. More...

::fwData::location::ILocation::sptr	m_location
	Object location ( file path, directory path, url, etc )

std::string	m_extension
	Extension of file format.

Demangling methods
virtual const std::string &	getLeafClassname () const override
	return object's classname without its namespace, i.e. BaseObject

virtual const std::string &	getClassname () const override
	return full object's classname with its namespace, i.e. fwCore::BaseObject

static const std::string &	leafClassname ()
	return object's classname without its namespace, i.e. BaseObject

static const std::string &	classname ()
	return object's classname without its namespace, i.e. BaseObject

Detailed Description

Base class for all object writers.

This class defines the API to use basic object writers. This writer is not a service. Their equivalent exist as services see fwIO::IWriter. To write an object with this class, use setLocation and setOject method before execute the method write.

Definition at line 41 of file IObjectWriter.hpp.

Member Function Documentation

std::string fwDataIO::writer::IObjectWriter::extension ( )

pure virtual

Return the default filename extension can be dynamic.

Returns: m_extension

The extension can be empty (for a repository for example) or must return a string BEGINNING WITH A DOT by default be empty

Implemented in fwGdcmIO::writer::Series, fwGdcmIO::helper::DicomSeriesWriter, fwVtkIO::ModelSeriesObjWriter, fwGdcmIO::writer::SurfaceSegmentation, vtkGdcmIO::ImageSeriesWriter, fwDataIO::writer::MeshWriter, fwGdcmIO::helper::DicomSeriesDBWriter, fwGdcmIO::writer::SeriesDB, fwVtkIO::ImageWriter, fwVtkIO::MeshWriter, fwVtkIO::MetaImageWriter, fwVtkIO::VtiImageWriter, fwDataIO::writer::GzBufferImageWriter, fwDataIO::writer::TransformationMatrix3DWriter, fwDataIO::writer::GzArrayWriter, fwDataIO::writer::ArrayWriter, fwItkIO::JpgImageWriter, and fwItkIO::ImageWriter.

Definition at line 60 of file IObjectWriter.cpp.

fwData::location::ILocation::sptr fwDataIO::writer::IObjectWriter::getLocation ( )

virtual

m_location getter.

Returns: m_location

Definition at line 53 of file IObjectWriter.cpp.

References m_location.

fwTools::Object::csptr fwDataIO::writer::IObjectWriter::getObject ( ) const

virtual

m_object getter.

Returns: m_object

Definition at line 38 of file IObjectWriter.cpp.

References m_object.

Referenced by fwDataIO::writer::GenericObjectWriter< ::fwData::Image >::getConcreteObject().

Here is the caller graph for this function:

void fwDataIO::writer::IObjectWriter::setLocation ( const ::fwData::location::ILocation::sptr location )

virtual

m_location setter.

Parameters

[in] location set location where object will be saved

Definition at line 46 of file IObjectWriter.cpp.

References m_location.

void fwDataIO::writer::IObjectWriter::setObject ( ::fwTools::Object::csptr object )

virtual

m_object setter.

Parameters

[in] _pObject replace m_object of the instance writer

Note: m_object is save in class with a weakptr; This object can be get with the method getObject()

Definition at line 31 of file IObjectWriter.cpp.

References m_object.

Referenced by fwDataIO::writer::GenericObjectWriter< ::fwData::Image >::setObject().

Here is the caller graph for this function:

virtual FWDATAIO_API void fwDataIO::writer::IObjectWriter::write ( )

pure virtual

Defines an writer interface.

This method write the object given in parameter of setObject method.

Implemented in fwGdcmIO::helper::DicomSeriesDBWriter, fwGdcmIO::helper::DicomSeriesWriter, fwGdcmIO::writer::Series, fwVtkIO::ModelSeriesObjWriter, fwGdcmIO::writer::SurfaceSegmentation, vtkGdcmIO::ImageSeriesWriter, fwDataIO::writer::MeshWriter, fwVtkIO::ImageWriter, fwVtkIO::MeshWriter, fwVtkIO::MetaImageWriter, fwVtkIO::VtiImageWriter, fwDataIO::writer::GzBufferImageWriter, fwGdcmIO::writer::SeriesDB, fwDataIO::writer::TransformationMatrix3DWriter, fwDataIO::writer::GzArrayWriter, fwDataIO::writer::ArrayWriter, fwItkIO::JpgImageWriter, and fwItkIO::ImageWriter.

Member Data Documentation

::fwTools::Object::cwptr fwDataIO::writer::IObjectWriter::m_object

protected

Object write on filesystem by the process.

This object is given in parameter of setObject method but it is conserved with a weakptr.

Definition at line 137 of file IObjectWriter.hpp.

Referenced by getObject(), setObject(), fwVtkIO::MetaImageWriter::write(), fwVtkIO::VtiImageWriter::write(), fwVtkIO::MeshWriter::write(), fwVtkIO::ImageWriter::write(), and fwVtkIO::ModelSeriesObjWriter::write().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Demangling methods

Detailed Description

Member Function Documentation

Member Data Documentation