aimsdata 6.0.0
Neuroimaging data handling
aims::VolumeRefFormat< T > Class Template Reference

#include <aims/io/baseFormats_cartovolume.h>

Inheritance diagram for aims::VolumeRefFormat< T >:
Collaboration diagram for aims::VolumeRefFormat< T >:

Public Member Functions

 VolumeRefFormat (const std::string &prefformat=std::string())
 
virtual ~VolumeRefFormat ()
 
virtual bool read (const std::string &filename, carto::VolumeRef< T > &vol, const carto::AllocatorContext &context, carto::Object options)
 
virtual bool write (const std::string &filename, const carto::VolumeRef< T > &vol, carto::Object options=carto::none())
 
virtual carto::VolumeRef< T > * read (const std::string &filename, const carto::AllocatorContext &context, carto::Object options)
 Creates an object and reads it.
 
- Public Member Functions inherited from aims::FileFormat< carto::VolumeRef< T > >
carto::GenericObjectread (const std::string &, const carto::AllocatorContext &, carto::Object)
 
virtual ~FileFormat ()
 
virtual bool read (const std::string &filename, T &obj, const carto::AllocatorContext &context, carto::Object options)=0
 
carto::GenericObjectread (const std::string &, const carto::AllocatorContext &, carto::Object)
 
virtual bool write (const std::string &, const T &, carto::Object options=carto::none())
 the base class has a default implementation which only returns false so if your new format only supports read operations, you won't have to bother about the write() function
 

Detailed Description

template<typename T>
class aims::VolumeRefFormat< T >

Definition at line 72 of file baseFormats_cartovolume.h.

Constructor & Destructor Documentation

◆ VolumeRefFormat()

template<typename T>
aims::VolumeRefFormat< T >::VolumeRefFormat ( const std::string & prefformat = std::string())

Definition at line 185 of file fileFormat_cartovolume_d.h.

◆ ~VolumeRefFormat()

template<typename T>
aims::VolumeRefFormat< T >::~VolumeRefFormat ( )
virtual

Definition at line 192 of file fileFormat_cartovolume_d.h.

Member Function Documentation

◆ read() [1/2]

template<typename T>
bool aims::VolumeRefFormat< T >::read ( const std::string & filename,
carto::VolumeRef< T > & vol,
const carto::AllocatorContext & context,
carto::Object options )
virtual

Definition at line 198 of file fileFormat_cartovolume_d.h.

References carto::rc_ptr< typename T >::reset().

◆ read() [2/2]

template<typename T>
carto::VolumeRef< T > * aims::VolumeRefFormat< T >::read ( const std::string & filename,
const carto::AllocatorContext & context,
carto::Object options )
virtual

Creates an object and reads it.

The default implementation just calls the other read() function. The returned object may be deleted by the standard delete

Reimplemented from aims::FileFormat< carto::VolumeRef< T > >.

Definition at line 215 of file fileFormat_cartovolume_d.h.

◆ write()

template<typename T>
bool aims::VolumeRefFormat< T >::write ( const std::string & filename,
const carto::VolumeRef< T > & vol,
carto::Object options = carto::none() )
virtual

Definition at line 227 of file fileFormat_cartovolume_d.h.


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