te::xerces::Module Class Reference

The TerraLib Xerces module is a plugin. More...

#include <Module.h>

Inheritance diagram for te::xerces::Module:
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...
 
 Module (const te::plugin::PluginInfo &pInfo)
 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 ()
 This method will be called by TerraLib to shutdown plugin's functionality. More...
 
void startup ()
 This method will be called by TerraLib to startup some plugin's functionality. More...
 
 ~Module ()
 

Static Public Member Functions

static void finalize ()
 It finalizes all TerraLib XERCES driver support. More...
 
static void initialize ()
 It initializes all TerraLib XERCES driver support. More...
 

Static Public Attributes

static bool m_initialized
 

Protected Attributes

PluginInfo m_pluginInfo
 Information about the plugin. More...
 

Detailed Description

The TerraLib Xerces module is a plugin.

Definition at line 42 of file Module.h.

Constructor & Destructor Documentation

te::xerces::Module::Module ( const te::plugin::PluginInfo pInfo)

Plugin constructor.

Parameters
pInfoBasic information needed to initialize the plugin.
te::xerces::Module::~Module ( )

Member Function Documentation

static void te::xerces::Module::finalize ( )
static

It finalizes all TerraLib XERCES driver support.

Note
This function must be called once in your program. This must be the last call to TerraLib XERCES driver. As the Initialize function, this can be called at the end of the main routine of your application.
Warning
Not thread safe!
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.

static void te::xerces::Module::initialize ( )
static

It initializes all TerraLib XERCES driver support.

The initialization includes:

  • Multilanguage support;
  • Logger initialization.
Note
This function must be called once in your program. I think that the best place to call it, is inside the main routine of your application.
Warning
Not thread safe!
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::xerces::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::xerces::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::xerces::Module::m_initialized
static

Definition at line 97 of file Module.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: