te::plugin::CppPlugin Class Reference

An abstract interface for Plugins written in C++. More...

#include <CppPlugin.h>

Inheritance diagram for te::plugin::CppPlugin:

Public Member Functions
	CppPlugin (const PluginInfo &info)
	It creates a new C++ plugin. More...
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	~CppPlugin ()
	Virtual destructor. 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...

Private Member Functions
Not Allowed Methods
No copy allowed.
	CppPlugin (const CppPlugin &rhs)
	No copy constructor allowed. More...
CppPlugin &	operator= (const CppPlugin &rhs)
	No assignment operator allowed. More...

Detailed Description

An abstract interface for Plugins written in C++.

Remember to implement the startup and shutdown methods from the base class: Plugin.

See also

Plugin, PluginManager

Definition at line 48 of file CppPlugin.h.

Constructor & Destructor Documentation

te::plugin::CppPlugin::CppPlugin

(

const PluginInfo &

info

)

It creates a new C++ plugin.

Parameters

info	Information about a C++ plugin.

Definition at line 29 of file CppPlugin.cpp.

te::plugin::CppPlugin::~CppPlugin ( )

virtual

Virtual destructor.

Definition at line 34 of file CppPlugin.cpp.

te::plugin::CppPlugin::CppPlugin ( const CppPlugin &  rhs )

private

No copy constructor allowed.

Parameters

rhs	The other instance.

Member Function Documentation

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

virtualinherited

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 te::plugin::Plugin::m_pluginInfo.

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

virtualinherited

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().

CppPlugin& te::plugin::CppPlugin::operator= ( const CppPlugin &  rhs )

private

No assignment operator allowed.

Parameters

rhs	The other instance.

Returns

A reference for this instance.

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

virtualinherited

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::vp::Plugin, te::qt::plugins::gdal::Plugin, te::qt::plugins::ogr::Plugin, te::qt::plugins::terralib4::Plugin, te::qt::plugins::layout::Plugin, te::qt::plugins::layout2::Plugin, te::qt::plugins::slider::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 ( )

virtualinherited

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::pgis::Module, te::qt::plugins::rp::Plugin, te::xerces::Module, te::qt::plugins::vp::Plugin, te::qt::plugins::gdal::Plugin, te::qt::plugins::ogr::Plugin, te::qt::plugins::terralib4::Plugin, te::qt::plugins::layout::Plugin, te::qt::plugins::layout2::Plugin, te::qt::plugins::slider::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

protectedinherited

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

protectedinherited

Information about the plugin.

Definition at line 78 of file Plugin.h.

Referenced by te::plugin::Plugin::getInfo().

---

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

• C:/BB_TL5/terralib5/src/terralib/plugin/CppPlugin.h
• C:/BB_TL5/terralib5/src/terralib/plugin/CppPlugin.cpp