fwDataIO::writer::GenericObjectWriter< DATATYPE > Class Template Reference

generic class for all object writers. More...

#include <GenericObjectWriter.hpp>

Inheritance diagram for fwDataIO::writer::GenericObjectWriter< DATATYPE >:

Collaboration diagram for fwDataIO::writer::GenericObjectWriter< DATATYPE >:

Public Types
typedef DATATYPE	DataType
	the object type related
Public Types inherited from fwDataIO::writer::IObjectWriter
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
	GenericObjectWriter ()
	Constructor. Do nothing.
virtual	~GenericObjectWriter ()
	Destructor. Do nothing.
virtual void	setObject (::fwTools::Object::csptr obj) override
	m_object setter. More...
virtual std::shared_ptr< const DataType >	getConcreteObject () const
	m_object getter. More...
Public Member Functions inherited from fwDataIO::writer::IObjectWriter
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::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.
virtual const std::string &	getLeafClassname () const override
	return object's classname without its namespace, i.e. BaseObject
Public Member Functions inherited from fwCore::BaseObject

Static Public Member Functions
static bool	isTypeOf (const std::string &type)
Static Public Member Functions inherited from fwDataIO::writer::IObjectWriter
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
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

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

Additional Inherited Members
Protected Member Functions inherited from fwDataIO::writer::IObjectWriter
FWDATAIO_API	IObjectWriter ()
	Constructor. Do nothing.
virtual FWDATAIO_API	~IObjectWriter ()
	Destructor. Do nothing.
Protected Attributes inherited from fwDataIO::writer::IObjectWriter
::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.

Detailed Description

template<class DATATYPE>
class fwDataIO::writer::GenericObjectWriter< DATATYPE >

generic class for all object writers.

This class adds 2 methods to the API of IObjectWriter. This generic reader test the object type given to the method setObject. And add a new get method getConcreteObject() that returns an object already cast.

Definition at line 27 of file GenericObjectWriter.hpp.

Member Function Documentation

template<class DATATYPE>

virtual std::shared_ptr< const DataType > fwDataIO::writer::GenericObjectWriter< DATATYPE >::getConcreteObject ( ) const

inlinevirtual

m_object getter.

Returns

m_object

This method automatic cast object in correct DataType.

Definition at line 67 of file GenericObjectWriter.hpp.

template<class DATATYPE>

virtual void fwDataIO::writer::GenericObjectWriter< DATATYPE >::setObject ( ::fwTools::Object::csptr  obj )

inlineoverridevirtual

m_object setter.

Parameters

[out]

obj

replace weakptr m_object of the instance reader

This method overload setObject to ensure that given object correspond to DATATYPE

Reimplemented from fwDataIO::writer::IObjectWriter.

Definition at line 53 of file GenericObjectWriter.hpp.

---

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

• GenericObjectWriter.hpp