fw4spl
fwDataIO::writer::GzArrayWriter Class Reference

Array Writer. Write file format .raw.gz. More...

#include <GzArrayWriter.hpp>

+ Inheritance diagram for fwDataIO::writer::GzArrayWriter:
+ Collaboration diagram for fwDataIO::writer::GzArrayWriter:

Public Member Functions

virtual bool isA (const std::string &type) const override
 
FWDATAIO_API GzArrayWriter (::fwDataIO::writer::IObjectWriter::Key key)
 Constructor. Do nothing.
 
virtual FWDATAIO_API ~GzArrayWriter ()
 Destructor. Do nothing.
 
virtual FWDATAIO_API void write () override
 Read the file with zlib API. More...
 
virtual FWDATAIO_API std::string extension () override
 Defines extension supported by this writer ".raw.gz".
 
- Public Member Functions inherited from fwDataIO::writer::GenericObjectWriter< ::fwData::Array >
 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 DataTypegetConcreteObject () const
 m_object getter. More...
 
- Public Member Functions inherited from fwDataIO::writer::IObjectWriter
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 void cancel ()
 Requests writer abortion.
 
virtual std::shared_ptr< ::fwJobs::IJobgetJob () const
 Returns the internal job, nullptr by default.
 
- Public Member Functions inherited from fwCore::BaseObject
- Public Member Functions inherited from fwData::location::enableSingleFile< ::fwDataIO::writer::IObjectWriter >
 enableSingleFile (::fwDataIO::writer::IObjectWriter *rw)
 constructor More...
 
void setFile (ILocation::PathType path)
 Set file system path.
 
ILocation::PathType getFile ()
 Get file system path.
 

Static Public Member Functions

static bool isTypeOf (const std::string &type)
 
- Static Public Member Functions inherited from fwDataIO::writer::GenericObjectWriter< ::fwData::Array >
static bool isTypeOf (const std::string &type)
 
static const std::string & classname ()
 return full object's classname with its namespace, i.e. fwCore::BaseObject
 
- 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
 

Friends

template<class , class , class >
class ::fwTools::ClassFactory
 
class ::fwTools::Factory
 

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
 

Additional Inherited Members

- Public Types inherited from fwDataIO::writer::GenericObjectWriter< ::fwData::Array >
typedef ::fwData::Array 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
 
- 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

Array Writer. Write file format .raw.gz.

Ircad writer to write a fwData::Array on filesystem which the file format is .raw.gz. This format is basic. The buffer is written in a file with zlib.

Definition at line 28 of file GzArrayWriter.hpp.

Member Function Documentation

void fwDataIO::writer::GzArrayWriter::write ( )
overridevirtual

Read the file with zlib API.

test if can open archive

Implements fwDataIO::writer::IObjectWriter.

Definition at line 41 of file GzArrayWriter.cpp.

References fwDataTools::helper::ArrayGetter::getBuffer(), fwDataIO::writer::GenericObjectWriter< ::fwData::Array >::getConcreteObject(), and fwData::location::enableSingleFile< ::fwDataIO::writer::IObjectWriter >::getFile().

+ Here is the call graph for this function:


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