vlVolDataLayoutPlugin Class Reference

Base class for volume data layout plugins. More...

#include <vlvoldatalayoutplugin.h>

Inheritance diagram for vlVolDataLayoutPlugin:

List of all members.

Public Member Functions
	vlVolDataLayoutPlugin ()
	Default constructor for vlVolDataLayoutPlugin.
virtual	~vlVolDataLayoutPlugin ()
	Default destructor.
virtual vlVolData *	getLayout (const vlDataType &datatype, const vlDim &dim, const vlUnit &units)=0
	Get a layout.
virtual vlVolIterSuperBase *	getIter (vlVolume *vol)=0
	Get an iterator object for the layout.
virtual vlVolIterSuperBase *	getConstIter (const vlVolume *vol)=0
	Get a const iterator object for the layout.
virtual vlLayoutType	layoutType () const=0
	Get the layout type supported by this plugin.
Static Protected Attributes
const std::string	m_baseService = "VolDataLayout"
const std::string	m_baseServiceDesc = "OpenVL Volume data layout plugin"
const int	m_APIVersionMajor = 1
const int	m_APIVersionMinor = 0
const int	m_APIVersionRevision = 0

---

Detailed Description

Author:

Sarang Lakare <sarang@users.sf.net>

Definition at line 47 of file vlvoldatalayoutplugin.h.

---

Constructor & Destructor Documentation

vlVolDataLayoutPlugin::vlVolDataLayoutPlugin (   )

Definition at line 32 of file vlvoldatalayoutplugin.cpp. References vlPlugin::infoRef(), m_APIVersionMajor, m_APIVersionMinor, m_APIVersionRevision, m_baseService, m_baseServiceDesc, vlPluginInfo::setAPIVersion(), and vlPluginInfo::setServiceGroup().

vlVolDataLayoutPlugin::~vlVolDataLayoutPlugin (   )  [virtual]

Definition at line 38 of file vlvoldatalayoutplugin.cpp.

---

Member Function Documentation

virtual vlVolIterSuperBase* vlVolDataLayoutPlugin::getConstIter (  const vlVolume *  vol  )  [pure virtual]

Implemented in vlVolDataDiskRawPlugin, vlVolDataRLEncode, and vlVolDataLinear. Referenced by vlVolSpaceIterConst< DataType, vlLayout::Generic >::vlVolSpaceIterConst().

virtual vlVolIterSuperBase* vlVolDataLayoutPlugin::getIter (  vlVolume *  vol  )  [pure virtual]

Implemented in vlVolDataDiskRawPlugin, vlVolDataRLEncode, and vlVolDataLinear.

virtual vlVolData* vlVolDataLayoutPlugin::getLayout (  const vlDataType &  datatype, const vlDim &  dim, const vlUnit &  units )  [pure virtual]

The user is responsible for deleting the pointer. The voxel datatype The dimension of the data The unit size along each axis Implemented in vlVolDataDiskRawPlugin, vlVolDataRLEncode, and vlVolDataLinear. Referenced by vlVolume::createData(), and vlVolume::resizeData().

virtual vlLayoutType vlVolDataLayoutPlugin::layoutType (   )  const [pure virtual]

Implemented in vlVolDataDiskRawPlugin, vlVolDataRLEncode, and vlVolDataLinear.

---

Member Data Documentation

const int vlVolDataLayoutPlugin::m_APIVersionMajor = 1 [static, protected]

Definition at line 85 of file vlvoldatalayoutplugin.h. Referenced by vlVolDataLayoutPlugin().

const int vlVolDataLayoutPlugin::m_APIVersionMinor = 0 [static, protected]

Definition at line 86 of file vlvoldatalayoutplugin.h. Referenced by vlVolDataLayoutPlugin().

const int vlVolDataLayoutPlugin::m_APIVersionRevision = 0 [static, protected]

Definition at line 87 of file vlvoldatalayoutplugin.h. Referenced by vlVolDataLayoutPlugin().

const std::string vlVolDataLayoutPlugin::m_baseService = "VolDataLayout" [static, protected]

Definition at line 29 of file vlvoldatalayoutplugin.cpp. Referenced by vlVolDataLayoutPlugin().

const std::string vlVolDataLayoutPlugin::m_baseServiceDesc = "OpenVL Volume data layout plugin" [static, protected]

Definition at line 30 of file vlvoldatalayoutplugin.cpp. Referenced by vlVolDataLayoutPlugin().

---

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

• vlvoldatalayoutplugin.h
• vlvoldatalayoutplugin.cpp

---