te::plugin::Plugin Class Reference

A base class for plugin types. More...

#include <Plugin.h>

Inheritance diagram for te::plugin::Plugin:

Public Member Functions
const PluginInfo &	getInfo () const
	It return the information associated to the plugin. More...
bool	isStarted () const
	It tells if the plugin was started or not. More...
bool	operator< (const AbstractPlugin &rhs) const
	This overloaded operator can be used to index the plugin in a set. More...
virtual void	shutdown ()
	Do nothing! Just set plugin as stopped. More...
virtual void	startup ()
	Do nothing! Just set plugin as started. More...
virtual	~Plugin ()
	Virtual destructor. More...

Protected Member Functions
	Plugin (const PluginInfo &pInfo)
	It initializes a new plugin. More...

Protected Attributes
bool	m_initialized
	A flag that indicates if the plugin was started or not. More...
PluginInfo	m_pluginInfo
	Information about the plugin. More...

Detailed Description

A base class for plugin types.

This class already provides a default implementation for all plugin methods and some attributes.

See also

AbstractPlugin, PluginManager, PluginInfo, PluginEngine

Definition at line 50 of file Plugin.h.

Constructor & Destructor Documentation

te::plugin::Plugin::~Plugin ( )

virtual

Virtual destructor.

Reimplemented in te::qt::plugins::rp::Plugin, te::qt::plugins::sa::Plugin, te::qt::plugins::vp::Plugin, te::qt::plugins::addressgeocoding::Plugin, te::qt::plugins::gdal::Plugin, te::qt::plugins::ogr::Plugin, te::qt::plugins::terralib4::Plugin, te::qt::plugins::st::Plugin, te::qt::plugins::attributefill::Plugin, te::qt::plugins::cellspace::Plugin, te::qt::plugins::edit::Plugin, te::qt::plugins::layout::Plugin, te::qt::plugins::ado::Plugin, te::qt::plugins::geofile::Plugin, te::qt::plugins::mysql::Plugin, te::qt::plugins::pgis::Plugin, te::qt::plugins::sqlite::Plugin, te::qt::plugins::wcs::Plugin, te::qt::plugins::wfs::Plugin, and te::qt::plugins::wms::Plugin.

Definition at line 49 of file Plugin.cpp.

te::plugin::Plugin::Plugin ( const PluginInfo &  pInfo )

protected

It initializes a new plugin.

Parameters

pInfo

Basic plugin information.

Definition at line 53 of file Plugin.cpp.

Member Function Documentation

const te::plugin::PluginInfo & te::plugin::Plugin::getInfo ( ) const

virtual

It return the information associated to the plugin.

Returns

The information associated to the plugin.

Implements te::plugin::AbstractPlugin.

Definition at line 29 of file Plugin.cpp.

References m_pluginInfo.

bool te::plugin::Plugin::isStarted ( ) const

virtual

It tells if the plugin was started or not.

Returns

True if the plugin is started and false otherwise (it is shutdown).

Implements te::plugin::AbstractPlugin.

Definition at line 34 of file Plugin.cpp.

bool te::plugin::AbstractPlugin::operator< ( const AbstractPlugin &  rhs ) const

inherited

This overloaded operator can be used to index the plugin in a set.

Parameters

rhs	The right-hand-side plugin.

Returns

True if this plugin name is lexcographical less than the rhs plugin name.

Definition at line 38 of file AbstractPlugin.cpp.

References te::plugin::AbstractPlugin::getInfo().

void te::plugin::Plugin::shutdown ( )

virtual

Do nothing! Just set plugin as stopped.

Implements te::plugin::AbstractPlugin.

Reimplemented in te::ogr::Module, te::grib::Platform, te::ado::Module, terralib4::Module, te::gdal::Module, te::wcs::Module, te::wfs::Module, te::wms::Module, te::pgis::Module, te::qt::plugins::rp::Plugin, te::xerces::Module, te::qt::plugins::sa::Plugin, te::qt::plugins::vp::Plugin, te::qt::plugins::addressgeocoding::Plugin, te::qt::plugins::gdal::Plugin, te::qt::plugins::ogr::Plugin, te::qt::plugins::terralib4::Plugin, te::qt::plugins::st::Plugin, te::qt::plugins::attributefill::Plugin, te::qt::plugins::cellspace::Plugin, te::qt::plugins::edit::Plugin, te::qt::plugins::layout::Plugin, te::qt::plugins::ado::Plugin, te::qt::plugins::geofile::Plugin, te::qt::plugins::mysql::Plugin, te::qt::plugins::pgis::Plugin, te::qt::plugins::sqlite::Plugin, te::qt::plugins::wcs::Plugin, te::qt::plugins::wfs::Plugin, te::qt::plugins::wms::Plugin, and te::sqlite::Module.

Definition at line 44 of file Plugin.cpp.

void te::plugin::Plugin::startup ( )

virtual

Do nothing! Just set plugin as started.

Implements te::plugin::AbstractPlugin.

Reimplemented in te::ogr::Module, te::grib::Platform, te::ado::Module, terralib4::Module, te::gdal::Module, te::wcs::Module, te::wfs::Module, te::wms::Module, te::qt::plugins::rp::Plugin, te::pgis::Module, te::qt::plugins::sa::Plugin, te::qt::plugins::vp::Plugin, te::xerces::Module, te::qt::plugins::addressgeocoding::Plugin, te::qt::plugins::gdal::Plugin, te::qt::plugins::ogr::Plugin, te::qt::plugins::terralib4::Plugin, te::qt::plugins::st::Plugin, te::qt::plugins::attributefill::Plugin, te::qt::plugins::cellspace::Plugin, te::qt::plugins::edit::Plugin, te::qt::plugins::layout::Plugin, te::qt::plugins::ado::Plugin, te::qt::plugins::geofile::Plugin, te::qt::plugins::mysql::Plugin, te::qt::plugins::pgis::Plugin, te::qt::plugins::sqlite::Plugin, te::qt::plugins::wcs::Plugin, te::qt::plugins::wfs::Plugin, te::qt::plugins::wms::Plugin, and te::sqlite::Module.

Definition at line 39 of file Plugin.cpp.

Member Data Documentation

bool te::plugin::Plugin::m_initialized

protected

A flag that indicates if the plugin was started or not.

Definition at line 79 of file Plugin.h.

PluginInfo te::plugin::Plugin::m_pluginInfo

protected

Information about the plugin.

Definition at line 78 of file Plugin.h.

Referenced by getInfo().

---

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

• C:/TL5_2015_release/terralib5/src/terralib/plugin/Plugin.h
• C:/TL5_2015_release/terralib5/src/terralib/plugin/Plugin.cpp