vlVolFioFilter Class Reference

This is the base class for all file io filters. More...

#include <vlvolfiofilter.h>

Inheritance diagram for vlVolFioFilter:

List of all members.

Public Member Functions
	vlVolFioFilter ()
	Default constructor.
virtual	~vlVolFioFilter ()
	Default destructor.
virtual const std::vector< std::string > &	getFileExtensions () const=0
	Return the list of valid file extensions for this file format.
virtual bool	readInfo (vlVolInfo &info, FILE *const fp, const std::string &filename)=0
	Read the volume information from the file into "info".
virtual bool	readData (vlVolInfo &info, vlVolData *const data, FILE *const fp, const std::string &filename)=0
	Load data into "data" from file using information in "info".
virtual bool	writeInfo (const vlVolInfo &info, FILE *const fp, const std::string &filename)=0
	Write just the volume information "info" to the file.
virtual bool	writeData (const vlVolInfo &info, const vlVolData *data, FILE *const fp, const std::string &filename)=0
	Write just the volume data to file.

---

Detailed Description

This class defines the functions that the derived classes need to implement so that vlVolume can use this filter to load volumes from disk or other source.

Design issues :

• Both fp and filename are passed to read/write calls so that the IO filters can decide what they want to use. Consider this case : header file is seperate from data file. How will the IO filters read the header file if only fp is passed!

Author:

Sarang Lakare (sarang@users.sourceforge.net)

Definition at line 61 of file vlvolfiofilter.h.

---

Constructor & Destructor Documentation

vlVolFioFilter::vlVolFioFilter (   )

Definition at line 29 of file vlvolfiofilter.cpp. References API_VERSION_MAJOR, API_VERSION_MINOR, API_VERSION_REV, vlPlugin::infoRef(), vlPluginInfo::setAPIVersion(), vlPluginInfo::setServiceGroup(), VL_BASE_SERVICE, and VL_BASE_SERVICE_DESC.

vlVolFioFilter::~vlVolFioFilter (   )  [virtual]

Definition at line 35 of file vlvolfiofilter.cpp.

---

Member Function Documentation

virtual const std::vector<std::string>& vlVolFioFilter::getFileExtensions (   )  const [pure virtual]

Implemented in vlVolFioDEN, vlVolFiof3d, vlVolFioPGMVol, vlVolFioPPM, vlVolFioRAW, vlVolFioSLC, and vlVolFioVOX. Referenced by vlKernel::getFileExtensionsKDEStyle(), vlVolume::read(), vlVolume::readImages(), vlVolume::readInfo(), vlVolume::readSubvolumes(), and vlVolume::write().

virtual bool vlVolFioFilter::readData (  vlVolInfo &  info, vlVolData *const  data, FILE *const  fp, const std::string &  filename )  [pure virtual]

Implemented in vlVolFioDEN, vlVolFiof3d, vlVolFioPGMVol, vlVolFioPPM, vlVolFioRAW, vlVolFioSLC, and vlVolFioVOX. Referenced by vlVolume::read(), vlVolume::readImages(), and vlVolume::readSubvolumes().

virtual bool vlVolFioFilter::readInfo (  vlVolInfo &  info, FILE *const  fp, const std::string &  filename )  [pure virtual]

Implemented in vlVolFioDEN, vlVolFiof3d, vlVolFioPGMVol, vlVolFioPPM, vlVolFioRAW, vlVolFioSLC, and vlVolFioVOX. Referenced by vlVolume::read(), vlVolume::readImages(), vlVolume::readInfo(), and vlVolume::readSubvolumes().

virtual bool vlVolFioFilter::writeData (  const vlVolInfo &  info, const vlVolData *  data, FILE *const  fp, const std::string &  filename )  [pure virtual]

Implemented in vlVolFioDEN, vlVolFiof3d, vlVolFioPGMVol, vlVolFioPPM, vlVolFioRAW, vlVolFioSLC, and vlVolFioVOX. Referenced by vlVolume::write().

virtual bool vlVolFioFilter::writeInfo (  const vlVolInfo &  info, FILE *const  fp, const std::string &  filename )  [pure virtual]

Implemented in vlVolFioDEN, vlVolFiof3d, vlVolFioPGMVol, vlVolFioPPM, vlVolFioRAW, vlVolFioSLC, and vlVolFioVOX. Referenced by vlVolume::write().

---

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

• vlvolfiofilter.h
• vlvolfiofilter.cpp

---