te::pgis::Module Class Reference

The TerraLib PostGIS driver is a plugin. More...

#include <Module.h>

Inheritance diagram for te::pgis::Module:
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...
 
 Module (const te::plugin::PluginInfo &pluginInfo)
 Plugin constructor. More...
 
bool operator< (const AbstractPlugin &rhs) const
 This overloaded operator can be used to index the plugin in a set. More...
 
 ~Module ()
 Destructor. More...
 
Re-Implmentation from Plugin Interface

Re-Implementation 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

The TerraLib PostGIS driver is a plugin.

Definition at line 42 of file Module.h.

Constructor & Destructor Documentation

te::pgis::Module::Module ( const te::plugin::PluginInfo pluginInfo)

Plugin constructor.

Parameters
pInfoBasic information provided to initialize this module through the plugin API.
te::pgis::Module::~Module ( )

Destructor.

Member Function Documentation

const 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.

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.

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.
void te::pgis::Module::shutdown ( )
virtual

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

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

Reimplemented from te::plugin::Plugin.

void te::pgis::Module::startup ( )
virtual

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

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

Reimplemented from te::plugin::Plugin.

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.


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