soma::VolumeRefFormatReader< T > Class Template Reference

FormatReader specialized for reference to 4D Volume. More...

#include <cartodata/io/volumeformatreader.h>

Inheritance diagram for soma::VolumeRefFormatReader< T >:

Collaboration diagram for soma::VolumeRefFormatReader< T >:

Public Member Functions
virtual	~VolumeRefFormatReader ()
virtual void	read (carto::VolumeRef< T > &obj, carto::rc_ptr< DataSourceInfo > dsi, const AllocatorContext &context, carto::Object options=carto::none())
	FormatReader derived function This method understands a volume and calls read( buffer ) with appropriate arguments.
void	attach (carto::rc_ptr< ImageReader< T > > imr)
	Linking to a ImageReader Allows us to declare only once the ImageReader.
virtual VolumeRef< T > *	createAndRead (carto::rc_ptr< DataSourceInfo > dsi, const AllocatorContext &context, carto::Object options)
	Factory mode: creates an object and reads it.
virtual void	setupAndRead (VolumeRef< T > &obj, carto::rc_ptr< DataSourceInfo > dsi, const AllocatorContext &context, carto::Object options)
	Full reading procedure, for an already existing object.
virtual FormatReader< carto::VolumeRef< T > > *	clone () const
virtual std::string	formatID () const
Public Member Functions inherited from soma::FormatReader< carto::VolumeRef< T > >
virtual	~FormatReader ()
virtual void	setupAndRead (T &obj, carto::rc_ptr< DataSourceInfo > dsi, const AllocatorContext &context, carto::Object options)
virtual void	read (T &obj, carto::rc_ptr< DataSourceInfo > dsi, const AllocatorContext &context, carto::Object options)
virtual carto::rc_ptr< DataSourceInfo >	checkDataSourceInfo (carto::rc_ptr< DataSourceInfo > dsi, carto::Object options)
virtual T *	create (carto::Object header, const AllocatorContext &context, carto::Object options)
virtual void	setup (T &obj, carto::Object header, const AllocatorContext &context, carto::Object options)

Protected Attributes
carto::rc_ptr< ImageReader< T > >	_imr

Detailed Description

template<typename T>
class soma::VolumeRefFormatReader< T >

FormatReader specialized for reference to 4D Volume.

See also

VolumeFormatReader

Definition at line 129 of file volumeformatreader.h.

Constructor & Destructor Documentation

~VolumeRefFormatReader()

template<typename T>

soma::VolumeRefFormatReader< T >::~VolumeRefFormatReader ( )

virtual

Definition at line 568 of file volumeformatreader_d.h.

Member Function Documentation

attach()

template<typename T>

void soma::VolumeRefFormatReader< T >::attach

(

carto::rc_ptr< ImageReader< T > >

imr

)

Linking to a ImageReader Allows us to declare only once the ImageReader.

Definition at line 663 of file volumeformatreader_d.h.

References _imr.

Referenced by clone().

clone()

template<typename T>

FormatReader< carto::VolumeRef< T > > * soma::VolumeRefFormatReader< T >::clone ( ) const

virtual

Implements soma::FormatReader< carto::VolumeRef< T > >.

Definition at line 671 of file volumeformatreader_d.h.

References _imr, and attach().

createAndRead()

template<typename T>

VolumeRef< T > * soma::VolumeRefFormatReader< T >::createAndRead ( carto::rc_ptr< DataSourceInfo > dsi, const AllocatorContext & context, carto::Object options )

virtual

Factory mode: creates an object and reads it.

The returned object belongs to the calling layer and may be deleted by the standard delete

Reimplemented from soma::FormatReader< carto::VolumeRef< T > >.

Definition at line 631 of file volumeformatreader_d.h.

References _imr, soma::VolumeFormatReader< T >::attach(), and soma::VolumeFormatReader< T >::createAndRead().

formatID()

template<typename T>

std::string soma::VolumeRefFormatReader< T >::formatID ( ) const

virtual

Implements soma::FormatReader< carto::VolumeRef< T > >.

Definition at line 680 of file volumeformatreader_d.h.

References _imr.

read()

template<typename T>

void soma::VolumeRefFormatReader< T >::read ( carto::VolumeRef< T > & obj, carto::rc_ptr< DataSourceInfo > dsi, const AllocatorContext & context, carto::Object options = carto::none() )

virtual

FormatReader derived function This method understands a volume and calls read( buffer ) with appropriate arguments.

Definition at line 649 of file volumeformatreader_d.h.

References _imr, soma::VolumeFormatReader< T >::attach(), and soma::VolumeFormatReader< T >::read().

setupAndRead()

template<typename T>

void soma::VolumeRefFormatReader< T >::setupAndRead ( VolumeRef< T > & obj, carto::rc_ptr< DataSourceInfo > dsi, const AllocatorContext & context, carto::Object options )

virtual

Full reading procedure, for an already existing object.

Definition at line 579 of file volumeformatreader_d.h.

References _imr, soma::VolumeFormatReader< T >::attach(), carto::rc_ptr< typename T >::get(), soma::VolumeUtilIO< T >::listReadProperties(), carto::Object::reference(), carto::rc_ptr< typename T >::reset(), soma::VolumeFormatReader< T >::setupAndRead(), setupAndRead(), carto::Carto2AimsHeaderTranslator::translate(), and carto::Object::value().

Referenced by setupAndRead().

Member Data Documentation

_imr

template<typename T>

carto::rc_ptr<ImageReader<T> > soma::VolumeRefFormatReader< T >::_imr

protected

Definition at line 166 of file volumeformatreader.h.

Referenced by attach(), clone(), createAndRead(), formatID(), read(), and setupAndRead().

---

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

• cartodata/io/volumeformatreader.h
• cartodata/io/volumeformatreader_d.h