cartodata  5.1.2
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. More...
 
void attach (carto::rc_ptr< ImageReader< T > > imr)
 Linking to a ImageReader Allows us to declare only once the ImageReader. More...
 
virtual VolumeRef< T > * createAndRead (carto::rc_ptr< DataSourceInfo > dsi, const AllocatorContext &context, carto::Object options)
 Factory mode: creates an object and reads it. More...
 
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. More...
 
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< DataSourceInfocheckDataSourceInfo (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.

Referenced by soma::VolumeRefFormatReader< T >::clone().

◆ clone()

template<typename T >
FormatReader< carto::VolumeRef< T > > * soma::VolumeRefFormatReader< T >::clone
virtual

◆ 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 soma::VolumeFormatReader< T >::attach(), and soma::VolumeFormatReader< T >::createAndRead().

◆ formatID()

template<typename T >
std::string soma::VolumeRefFormatReader< T >::formatID
virtual

◆ 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 soma::VolumeFormatReader< T >::attach(), and soma::VolumeFormatReader< T >::read().

◆ 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.


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