te::v8::plugin::Module Class Reference

An utility class to initialize and terminate TerraLib's Google JavaScript V8 engine module. More...

#include <Module.h>

Inheritance diagram for te::v8::plugin::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...
 
void shutdown () throw (...)
 It finalizes the TerraLib's Google JavaScript V8 engine module. More...
 
void startup () throw (...)
 This is the startup function for the TerraLib's Google JavaScript V8 engine module. More...
 
 ~Module ()
 destructor. More...
 

Protected Attributes

PluginInfo m_pluginInfo
 Information about the plugin. More...
 

Private Attributes

bool m_initialized
 A flag that indicates if the V8 Plugin module is initialized or not. More...
 

Detailed Description

An utility class to initialize and terminate TerraLib's Google JavaScript V8 engine module.

See also
te::plugin::CppPlugin

Definition at line 46 of file src/terralib/binding/v8/plugin/Module.h.

Constructor & Destructor Documentation

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

Plugin constructor.

Parameters
pInfoBasic information provided to initialize this module through the plugin API.

Definition at line 32 of file src/terralib/binding/v8/plugin/Module.cpp.

te::v8::plugin::Module::~Module ( )

destructor.

Definition at line 38 of file src/terralib/binding/v8/plugin/Module.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 te::v8::plugin::Module::shutdown ( )
throw (...
)
virtual

It finalizes the TerraLib's Google JavaScript V8 engine module.

Exceptions
ExceptionIt may throws an exception.
Warning
Not thread safe!

Reimplemented from te::plugin::Plugin.

Definition at line 58 of file src/terralib/binding/v8/plugin/Module.cpp.

References te::v8::plugin::PluginEngineFactory::finalize(), m_initialized, PLUGIN_CALL_BACK_IMPL, TE_LOG_TRACE, and TR_V8PLUGIN.

void te::v8::plugin::Module::startup ( )
throw (...
)
virtual

This is the startup function for the TerraLib's Google JavaScript V8 engine module.

The initialization includes:

Exceptions
ExceptionIt may throws an exception.
Warning
Not thread safe!

Reimplemented from te::plugin::Plugin.

Definition at line 42 of file src/terralib/binding/v8/plugin/Module.cpp.

References te::v8::plugin::PluginEngineFactory::initialize(), m_initialized, TE_ADD_TEXT_DOMAIN, TE_LOG_TRACE, TE_V8PLUGIN_TEXT_DOMAIN, TE_V8PLUGIN_TEXT_DOMAIN_DIR, and TR_V8PLUGIN.

Member Data Documentation

bool te::v8::plugin::Module::m_initialized
private

A flag that indicates if the V8 Plugin module is initialized or not.

Definition at line 86 of file src/terralib/binding/v8/plugin/Module.h.

Referenced by shutdown(), and startup().

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: