terralib4::Module Class Reference

#include <Module.h>

Inheritance diagram for terralib4::Module:

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
Constructor/Destructor.
	Module (const te::plugin::PluginInfo &pluginInfo)
	It creates a new C++ module. 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

Definition at line 42 of file Module.h.

Constructor & Destructor Documentation

terralib4::Module::Module

(

const te::plugin::PluginInfo &

pluginInfo

)

It creates a new C++ module.

Definition at line 40 of file Module.cpp.

terralib4::Module::~Module

(

)

Destructor.

Definition at line 45 of file Module.cpp.

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

void terralib4::Module::shutdown ( )

virtual

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

Exceptions

Exception

It throws an exception if the plugin can not be shutdown.

Reimplemented from te::plugin::Plugin.

Definition at line 65 of file Module.cpp.

References te::common::Singleton< DataSourceManager >::getInstance(), te::da::DataSourceFactory::remove(), TE_LOG_TRACE, TE_TR, and TERRALIB4_DRIVER_IDENTIFIER.

void terralib4::Module::startup ( )

virtual

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

Exceptions

Exception

It throws an exception if the plugin can not be started.

Reimplemented from te::plugin::Plugin.

Definition at line 49 of file Module.cpp.

References te::da::DataSourceFactory::add(), terralib4::Build(), terralib4::Globals::sm_capabilities, terralib4::Globals::sm_queryDialect, TE_LOG_TRACE, and TE_TR.

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:/TL5_2015_release/terralib5/src/terralib/terralib4/Module.h
• C:/TL5_2015_release/terralib5/src/terralib/terralib4/Module.cpp