HelloWorldPlugin Class Reference

Example.... More...

#include <HelloWorld.h>

Inheritance diagram for HelloWorldPlugin:
te::plugin::CppPlugin te::plugin::Plugin te::plugin::AbstractPlugin

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...
 
Initializer Methods

Methods related to instantiation and destruction.

 HelloWorldPlugin (const te::plugin::PluginInfo &pluginInfo)
 It creates a new C++ plugin. More...
 
 ~HelloWorldPlugin ()
 destructor. More...
 
Re-Implmentation from Plugin Interface

Re-Implmentation from Plugin Interface.

void startup ()
 This method will be called by TerraLib to startup some plugin's functionality. More...
 
void shutdown ()
 This method will be called by TerraLib to shutdown plugin's functionality. 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

Example....

See also
CppPlugin, Plugin, PluginManager

Definition at line 52 of file HelloWorld.h.

Constructor & Destructor Documentation

HelloWorldPlugin::HelloWorldPlugin ( const te::plugin::PluginInfo pluginInfo)

It creates a new C++ plugin.

Definition at line 29 of file HelloWorld.cpp.

HelloWorldPlugin::~HelloWorldPlugin ( )

destructor.

Definition at line 34 of file HelloWorld.cpp.

Member Function Documentation

const te::plugin::PluginInfo & 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 attic/src/plugin/Plugin.cpp.

References te::plugin::Plugin::m_pluginInfo.

bool 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 attic/src/plugin/Plugin.cpp.

References te::plugin::Plugin::m_initialized.

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

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

Parameters
rhsThe 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 HelloWorldPlugin::shutdown ( )
virtual

This method will be called by TerraLib to shutdown plugin's functionality.

Exceptions
ExceptionIt throws and exception if the plugin can not be shutdown.

Reimplemented from te::plugin::Plugin.

Definition at line 42 of file HelloWorld.cpp.

References PLUGIN_CALL_BACK_IMPL.

void HelloWorldPlugin::startup ( )
virtual

This method will be called by TerraLib to startup some plugin's functionality.

Exceptions
ExceptionIt throws and exception if the plugin can not be started.

Reimplemented from te::plugin::Plugin.

Definition at line 38 of file HelloWorld.cpp.

Member Data Documentation

PluginInfo te::plugin::Plugin::m_pluginInfo
protectedinherited

Information about the plugin.

Definition at line 78 of file attic/src/plugin/Plugin.h.

Referenced by te::plugin::Plugin::getInfo(), and te::sqlite::Module::startup().


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