aims::VolumeFormat< T > Class Template Reference

#include <aims/io/baseFormats_cartovolume.h>

Inheritance diagram for aims::VolumeFormat< T >:

Collaboration diagram for aims::VolumeFormat< T >:

Public Member Functions
	VolumeFormat (const std::string &prefformat=std::string())
virtual	~VolumeFormat ()
virtual bool	read (const std::string &filename, carto::Volume< T > &vol, const carto::AllocatorContext &context, carto::Object options)
virtual bool	write (const std::string &filename, const carto::Volume< T > &vol, 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 More...
virtual carto::Volume< T > *	read (const std::string &filename, const carto::AllocatorContext &context, carto::Object options)
	Creates an object and reads it. More...
Public Member Functions inherited from aims::FileFormat< carto::Volume< T > >
virtual	~FileFormat ()
carto::GenericObject *	read (const std::string &, const carto::AllocatorContext &, carto::Object)

Detailed Description

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

Definition at line 50 of file baseFormats_cartovolume.h.

Constructor & Destructor Documentation

VolumeFormat()

template<typename T >

aims::VolumeFormat< T >::VolumeFormat

(

const std::string &

prefformat = std::string()

)

Definition at line 51 of file fileFormat_cartovolume_d.h.

~VolumeFormat()

template<typename T >

aims::VolumeFormat< T >::~VolumeFormat ( )

virtual

Definition at line 58 of file fileFormat_cartovolume_d.h.

Member Function Documentation

read() [1/2]

template<typename T >

bool aims::VolumeFormat< T >::read ( const std::string &  filename, carto::Volume< T > &  vol, const carto::AllocatorContext &  context, carto::Object  options  )

virtual

Implements aims::FileFormat< carto::Volume< T > >.

Definition at line 64 of file fileFormat_cartovolume_d.h.

References aims::Reader< T >::read(), carto::ref< T >::release(), aims::Reader< T >::setAllocatorContext(), aims::Reader< T >::setOptions(), and AimsData< T >::volume().

read() [2/2]

template<typename T >

carto::Volume< T > * aims::VolumeFormat< 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::Volume< T > >.

Definition at line 95 of file fileFormat_cartovolume_d.h.

References aims::Reader< T >::read(), carto::ref< T >::release(), aims::Reader< T >::setAllocatorContext(), aims::Reader< T >::setOptions(), and AimsData< T >::volume().

write()

template<typename T >

bool aims::VolumeFormat< T >::write ( const std::string &  , const carto::Volume< T > &  , carto::Object  options = carto::none()  )

virtual

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

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

Definition at line 124 of file fileFormat_cartovolume_d.h.

References const_ref< GenericObject >::isNull(), carto::ref< T >::release(), and aims::Writer< T >::write().

---

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

• aims/io/baseFormats_cartovolume.h
• aims/io/fileFormat_cartovolume_d.h