te::xerces::Module Class Reference

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

#include <Module.h>

Inheritance diagram for te::xerces::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...
	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 = false

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

pInfo

Basic information needed to initialize the plugin.

Definition at line 41 of file Module.cpp.

te::xerces::Module::~Module

(

)

Definition at line 46 of file Module.cpp.

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

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.

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 te::xerces::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 80 of file Module.cpp.

References te::xerces::ReaderFactory::finalize(), te::xerces::WriterFactory::finalize(), TE_LOG_TRACE, and TE_TR.

void te::xerces::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 50 of file Module.cpp.

References te::xerces::ReaderFactory::initialize(), te::xerces::WriterFactory::initialize(), TE_LOG_TRACE, and TE_TR.

Member Data Documentation

bool te::xerces::Module::m_initialized = false

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.

Referenced by te::plugin::Plugin::getInfo().

---

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

• C:/TL5_2015_release/terralib5/src/terralib/xerces/Module.h
• C:/TL5_2015_release/terralib5/src/terralib/xerces/Module.cpp