Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members | Related Pages

vlPluginInfo Class Reference

This class stores information about a plugin. More...

#include <vlplugininfo.h>

List of all members.

Public Member Functions

 vlPluginInfo ()
 Default constructor.

 ~vlPluginInfo ()
 Default destructor.

std::string name () const
 Returns the name of the plugin.

vlVersion version () const
 Returns the version number of the plugin - not related to the API it implements.

vlVersion apiVersion () const
 Returns the API version of the API implemented by the plugin (say VolFileIO etc.).

vlVersion libAPIVersion () const
 Returns the API version of the underlying library/program which plugin uses.

std::string service () const
 Returns the name of the service that this plugin provides.

std::string serviceDesc () const
 Returns the description of the service this plugin provides.

std::string serviceGroup () const
 Returns the name of the group the service belongs to.

std::string serviceGroupDesc () const
 Returns the description of the group the service belongs to.

std::vector< std::string > authorList () const
 Returns the list of the authors.

std::vector< std::string > authorEmailList () const
 Returns the list of email addresses of author.

std::string copyrightText () const
 Returns the copyright of this plugin.

vlVarList const * extra () const
 Pointer to the storage of extra information for the plugin.

void setName (const std::string &name)
 Set the name for the plugin.

void setVersion (const uint16 major, const uint16 minor, const uint16 revision)
 Set the version of the plugin - not related to the API it implements.

void setAPIVersion (const uint16 major, const uint16 minor, const uint16 revision)
 Set the version of the API that the plugin implements.

void setLibAPIVersion (const uint16 major, const uint16 minor, const uint16 revision)
 Set the API version of the underlying library/program which plugin uses.

void setServiceGroup (const std::string &name, const std::string &desc)
 Sets the group to which the service belongs.

void setService (const std::string &name, const std::string &desc)
 Sets the service which the plugin provides.

void addAuthor (const std::string &name)
 Add an author w/o email ID.

void addAuthor (const std::string &name, const std::string &email)
 Add an author with email ID.

void setCopyrightText (const std::string &text)
 Set some copyright text.

vlVarList * extraRW ()
 A non-const pointer to the storage of extra information for the plugin so that the information can be modified.


Private Attributes

std::string m_name
 Name of the plugin.

vlVersion m_apiVersion
 API version of the API implemented by the plugin (say VolFileIO etc.).

vlVersion m_libAPIVersion
 API version of the underlying library/program which the plugin uses.

vlVersion m_version
 Version of the plugin - not related to the API version it implements.

std::string m_serviceGroup
 The base service that this plugin provides.. like VolProcessor etc.

std::string m_serviceGroupDesc
 The base service that this plugin provides.. like VolProcessor etc.

std::string m_service
 The core service that this plugin provides.. Like RegionGrow etc.

std::string m_serviceDesc
 The core service that this plugin provides.. Like RegionGrow etc.

std::vector< std::string > m_authorList
 A list of authors of the plugin.

std::vector< std::string > m_authorEmailList
 A list of email addresses of authors.

std::string m_copyrightText
 Stores the copyright for this plugin.

vlVarListAdmin m_extraInfo
 Storage for extra info.

Detailed Description

Author:
Sarang Lakare <sarang@users.sf.net>

Definition at line 41 of file vlplugininfo.h.

Constructor & Destructor Documentation

vlPluginInfo::vlPluginInfo (   ) 
 

Definition at line 29 of file vlplugininfo.cpp.

vlPluginInfo::~vlPluginInfo (   ) 
 

Definition at line 36 of file vlplugininfo.cpp.

Member Function Documentation

void vlPluginInfo::addAuthor (  const std::string &  name,
const std::string &  email
) 
 

Definition at line 175 of file vlplugininfo.cpp.

References m_authorEmailList, m_authorList, and name.

void vlPluginInfo::addAuthor (  const std::string &  name  ) 
 

Definition at line 167 of file vlplugininfo.cpp.

References m_authorEmailList, m_authorList, and name.

Referenced by vlInterpolatorNNPlugin::vlInterpolatorNNPlugin(), vlInterpolatorTriLinPlugin::vlInterpolatorTriLinPlugin(), vlRegionGrowOffsetFinder::vlRegionGrowOffsetFinder(), vlVolDataDiskRawPlugin::vlVolDataDiskRawPlugin(), vlVolDataLinear::vlVolDataLinear(), vlVolDataRLEncode::vlVolDataRLEncode(), vlVolFioPPM::vlVolFioPPM(), vlVolFioSLC::vlVolFioSLC(), vlVolFioVOX::vlVolFioVOX(), vlVolProcessorThresh::vlVolProcessorThresh(), vlVoxelOpCentralDiffPlugin::vlVoxelOpCentralDiffPlugin(), vlVoxelOpSobelPlugin::vlVoxelOpSobelPlugin(), and VolumeCrop::VolumeCrop().

vlVersion vlPluginInfo::apiVersion (   )  const
 

Definition at line 57 of file vlplugininfo.cpp.

References m_apiVersion.

Referenced by vlPluginManager::loadBuiltInPlugins(), vlPluginManager::loadPlugins(), and queryPlugin().

std::vector< std::string > vlPluginInfo::authorEmailList (   )  const
 

Use the author's index in authorList to get his/her email address.

Definition at line 101 of file vlplugininfo.cpp.

References m_authorEmailList.

std::vector< std::string > vlPluginInfo::authorList (   )  const
 

Definition at line 92 of file vlplugininfo.cpp.

References m_authorList.

std::string vlPluginInfo::copyrightText (   )  const
 

Definition at line 107 of file vlplugininfo.cpp.

References m_copyrightText.

vlVarList const * vlPluginInfo::extra (   )  const
 

Definition at line 112 of file vlplugininfo.cpp.

References m_extraInfo.

vlVarList * vlPluginInfo::extraRW (   ) 
 

Definition at line 188 of file vlplugininfo.cpp.

References m_extraInfo.

vlVersion vlPluginInfo::libAPIVersion (   )  const
 

Use this to indicate binary compatiblity breaks. For e.g., change the major number when a plugin should not be opened by newer versions.

Definition at line 62 of file vlplugininfo.cpp.

References m_libAPIVersion.

Referenced by vlPluginManager::loadPlugins(), and queryPlugin().

std::string vlPluginInfo::name (   )  const
 

Returns:
A string with the name

Definition at line 45 of file vlplugininfo.cpp.

References m_name.

Referenced by CreateVolume(), vlPluginManager::loadBuiltInPlugins(), vlPluginManager::loadPlugins(), queryPlugin(), and vlVolume::readInfo().

std::string vlPluginInfo::service (   )  const
 

Definition at line 68 of file vlplugininfo.cpp.

References m_service.

Referenced by vlVolume::createData(), vlVolume::dataLayoutName(), vlPluginManager::loadBuiltInPlugins(), vlPluginManager::loadPlugins(), queryPlugin(), vlVolume::read(), vlVolume::readImages(), vlVolume::readInfo(), vlVolume::readSubvolumes(), vlPluginManager::registerPlugin(), vlVolume::resizeData(), and vlVolume::write().

std::string vlPluginInfo::serviceDesc (   )  const
 

Definition at line 74 of file vlplugininfo.cpp.

References m_serviceDesc.

Referenced by vlPluginManager::loadBuiltInPlugins(), vlPluginManager::loadPlugins(), and queryPlugin().

std::string vlPluginInfo::serviceGroup (   )  const
 

Definition at line 80 of file vlplugininfo.cpp.

References m_serviceGroup.

Referenced by vlPluginManager::loadBuiltInPlugins(), vlPluginManager::loadPlugins(), queryPlugin(), and vlPluginManager::registerPlugin().

std::string vlPluginInfo::serviceGroupDesc (   )  const
 

Definition at line 86 of file vlplugininfo.cpp.

References m_serviceGroupDesc.

Referenced by vlPluginManager::loadBuiltInPlugins(), vlPluginManager::loadPlugins(), and queryPlugin().

void vlPluginInfo::setAPIVersion (  const uint16  major,
const uint16  minor,
const uint16  revision
) 
 

Definition at line 136 of file vlplugininfo.cpp.

References m_apiVersion.

Referenced by vlInterpolatorPlugin::vlInterpolatorPlugin(), vlVolDataLayoutPlugin::vlVolDataLayoutPlugin(), vlVolFioFilter::vlVolFioFilter(), vlVolProcessor::vlVolProcessor(), and vlVoxelOpPlugin::vlVoxelOpPlugin().

void vlPluginInfo::setCopyrightText (  const std::string &  text  ) 
 

Definition at line 183 of file vlplugininfo.cpp.

References m_copyrightText.

Referenced by vlInterpolatorNNPlugin::vlInterpolatorNNPlugin(), vlInterpolatorTriLinPlugin::vlInterpolatorTriLinPlugin(), vlRegionGrowOffsetFinder::vlRegionGrowOffsetFinder(), vlVolDataDiskRawPlugin::vlVolDataDiskRawPlugin(), vlVolDataLinear::vlVolDataLinear(), vlVolDataRLEncode::vlVolDataRLEncode(), vlVolFioPPM::vlVolFioPPM(), vlVolFioSLC::vlVolFioSLC(), vlVolFioVOX::vlVolFioVOX(), vlVolProcessorThresh::vlVolProcessorThresh(), vlVoxelOpCentralDiffPlugin::vlVoxelOpCentralDiffPlugin(), vlVoxelOpSobelPlugin::vlVoxelOpSobelPlugin(), and VolumeCrop::VolumeCrop().

void vlPluginInfo::setLibAPIVersion (  const uint16  major,
const uint16  minor,
const uint16  revision
) 
 

Use this to indicate binary compatiblity breaks. For e.g., change the major number when a plugin should not be opened by newer versions.

Definition at line 141 of file vlplugininfo.cpp.

References m_libAPIVersion.

Referenced by vlPlugin::vlPlugin().

void vlPluginInfo::setName (  const std::string &  name  ) 
 

Definition at line 120 of file vlplugininfo.cpp.

References m_name, and name.

Referenced by GaussianApprox::GaussianApprox(), vlInterpolatorNNPlugin::vlInterpolatorNNPlugin(), vlInterpolatorTriLinPlugin::vlInterpolatorTriLinPlugin(), vlRegionGrowOffsetFinder::vlRegionGrowOffsetFinder(), vlVolDataDiskRawPlugin::vlVolDataDiskRawPlugin(), vlVolDataLinear::vlVolDataLinear(), vlVolDataRLEncode::vlVolDataRLEncode(), vlVolFioDEN::vlVolFioDEN(), vlVolFiof3d::vlVolFiof3d(), vlVolFioPGMVol::vlVolFioPGMVol(), vlVolFioPPM::vlVolFioPPM(), vlVolFioRAW::vlVolFioRAW(), vlVolFioSLC::vlVolFioSLC(), vlVolFioVOX::vlVolFioVOX(), vlVolProcessorAlphaAdd::vlVolProcessorAlphaAdd(), vlVolProcessorCentralDiff::vlVolProcessorCentralDiff(), vlVolProcessorConcatenate::vlVolProcessorConcatenate(), vlVolProcessorDilate::vlVolProcessorDilate(), vlVolProcessorErode::vlVolProcessorErode(), vlVolProcessorRegionGrow::vlVolProcessorRegionGrow(), vlVolProcessorSobel::vlVolProcessorSobel(), vlVolProcessorThresh::vlVolProcessorThresh(), vlVoxelOpCentralDiffPlugin::vlVoxelOpCentralDiffPlugin(), vlVoxelOpSobelPlugin::vlVoxelOpSobelPlugin(), and VolumeCrop::VolumeCrop().

void vlPluginInfo::setService (  const std::string &  name,
const std::string &  desc
) 
 

This will be used to search for the plugin.

Definition at line 159 of file vlplugininfo.cpp.

References m_service, m_serviceDesc, and name.

Referenced by GaussianApprox::GaussianApprox(), vlInterpolatorNNPlugin::vlInterpolatorNNPlugin(), vlInterpolatorTriLinPlugin::vlInterpolatorTriLinPlugin(), vlPlugin::vlPlugin(), vlRegionGrowOffsetFinder::vlRegionGrowOffsetFinder(), vlVolDataDiskRawPlugin::vlVolDataDiskRawPlugin(), vlVolDataLinear::vlVolDataLinear(), vlVolDataRLEncode::vlVolDataRLEncode(), vlVolFioDEN::vlVolFioDEN(), vlVolFiof3d::vlVolFiof3d(), vlVolFioPGMVol::vlVolFioPGMVol(), vlVolFioPPM::vlVolFioPPM(), vlVolFioRAW::vlVolFioRAW(), vlVolFioSLC::vlVolFioSLC(), vlVolFioVOX::vlVolFioVOX(), vlVolProcessorAlphaAdd::vlVolProcessorAlphaAdd(), vlVolProcessorCentralDiff::vlVolProcessorCentralDiff(), vlVolProcessorConcatenate::vlVolProcessorConcatenate(), vlVolProcessorDilate::vlVolProcessorDilate(), vlVolProcessorErode::vlVolProcessorErode(), vlVolProcessorRegionGrow::vlVolProcessorRegionGrow(), vlVolProcessorSobel::vlVolProcessorSobel(), vlVolProcessorThresh::vlVolProcessorThresh(), vlVoxelOpCentralDiffPlugin::vlVoxelOpCentralDiffPlugin(), vlVoxelOpSobelPlugin::vlVoxelOpSobelPlugin(), and VolumeCrop::VolumeCrop().

void vlPluginInfo::setServiceGroup (  const std::string &  name,
const std::string &  desc
) 
 

This will be used to search for the plugin.

Definition at line 150 of file vlplugininfo.cpp.

References m_serviceGroup, m_serviceGroupDesc, and name.

Referenced by vlInterpolatorPlugin::vlInterpolatorPlugin(), vlPlugin::vlPlugin(), vlVolDataLayoutPlugin::vlVolDataLayoutPlugin(), vlVolFioFilter::vlVolFioFilter(), vlVolProcessor::vlVolProcessor(), and vlVoxelOpPlugin::vlVoxelOpPlugin().

void vlPluginInfo::setVersion (  const uint16  major,
const uint16  minor,
const uint16  revision
) 
 

Definition at line 128 of file vlplugininfo.cpp.

References m_version.

Referenced by GaussianApprox::GaussianApprox(), vlInterpolatorNNPlugin::vlInterpolatorNNPlugin(), vlInterpolatorTriLinPlugin::vlInterpolatorTriLinPlugin(), vlRegionGrowOffsetFinder::vlRegionGrowOffsetFinder(), vlVolDataDiskRawPlugin::vlVolDataDiskRawPlugin(), vlVolDataLinear::vlVolDataLinear(), vlVolDataRLEncode::vlVolDataRLEncode(), vlVolFioDEN::vlVolFioDEN(), vlVolFiof3d::vlVolFiof3d(), vlVolFioPGMVol::vlVolFioPGMVol(), vlVolFioPPM::vlVolFioPPM(), vlVolFioRAW::vlVolFioRAW(), vlVolFioSLC::vlVolFioSLC(), vlVolFioVOX::vlVolFioVOX(), vlVolProcessorAlphaAdd::vlVolProcessorAlphaAdd(), vlVolProcessorCentralDiff::vlVolProcessorCentralDiff(), vlVolProcessorConcatenate::vlVolProcessorConcatenate(), vlVolProcessorDilate::vlVolProcessorDilate(), vlVolProcessorErode::vlVolProcessorErode(), vlVolProcessorRegionGrow::vlVolProcessorRegionGrow(), vlVolProcessorSobel::vlVolProcessorSobel(), vlVolProcessorThresh::vlVolProcessorThresh(), vlVoxelOpCentralDiffPlugin::vlVoxelOpCentralDiffPlugin(), vlVoxelOpSobelPlugin::vlVoxelOpSobelPlugin(), and VolumeCrop::VolumeCrop().

vlVersion vlPluginInfo::version (   )  const
 

Definition at line 51 of file vlplugininfo.cpp.

References m_version.

Referenced by vlPluginManager::loadBuiltInPlugins(), vlPluginManager::loadPlugins(), and queryPlugin().

Member Data Documentation

vlVersion vlPluginInfo::m_apiVersion [private]
 

Definition at line 165 of file vlplugininfo.h.

Referenced by apiVersion(), and setAPIVersion().

std::vector<std::string> vlPluginInfo::m_authorEmailList [private]
 

Definition at line 183 of file vlplugininfo.h.

Referenced by addAuthor(), and authorEmailList().

std::vector<std::string> vlPluginInfo::m_authorList [private]
 

Definition at line 180 of file vlplugininfo.h.

Referenced by addAuthor(), and authorList().

std::string vlPluginInfo::m_copyrightText [private]
 

Definition at line 186 of file vlplugininfo.h.

Referenced by copyrightText(), and setCopyrightText().

vlVarListAdmin vlPluginInfo::m_extraInfo [private]
 

Definition at line 189 of file vlplugininfo.h.

Referenced by extra(), and extraRW().

vlVersion vlPluginInfo::m_libAPIVersion [private]
 

Definition at line 168 of file vlplugininfo.h.

Referenced by libAPIVersion(), and setLibAPIVersion().

std::string vlPluginInfo::m_name [private]
 

Definition at line 162 of file vlplugininfo.h.

Referenced by name(), and setName().

std::string vlPluginInfo::m_service [private]
 

Definition at line 177 of file vlplugininfo.h.

Referenced by service(), and setService().

std::string vlPluginInfo::m_serviceDesc [private]
 

Definition at line 177 of file vlplugininfo.h.

Referenced by serviceDesc(), and setService().

std::string vlPluginInfo::m_serviceGroup [private]
 

Definition at line 174 of file vlplugininfo.h.

Referenced by serviceGroup(), and setServiceGroup().

std::string vlPluginInfo::m_serviceGroupDesc [private]
 

Definition at line 174 of file vlplugininfo.h.

Referenced by serviceGroupDesc(), and setServiceGroup().

vlVersion vlPluginInfo::m_version [private]
 

Definition at line 171 of file vlplugininfo.h.

Referenced by setVersion(), and version().

The documentation for this class was generated from the following files:
Generated on Fri Mar 18 11:33:19 2005 for OpenVL by doxygen 1.3.3