te::grib::Platform Class Reference

A utility class to initialize and terminate TerraLib GRIB driver support. More...

#include <Platform.h>

Inheritance diagram for te::grib::Platform:

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.
	Platform (const te::plugin::PluginInfo &pluginInfo)
	It creates a new C++ module. More...
	~Platform ()
	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...

Static Public Member Functions
Static Initializer Methods
Methods that can be used to initialize the GRIB module.
static void	initialize ()
	It initializes all TerraLib GRIB driver support. More...
static void	finalize ()
	It finalizes all TerraLib GRIB driver support. More...

Static Public Attributes
static bool	sm_gribInitialized
	A flag that indicates if the GRIB driver is initialized or not. 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

A utility class to initialize and terminate TerraLib GRIB driver support.

Definition at line 45 of file Platform.h.

Constructor & Destructor Documentation

te::grib::Platform::Platform

(

const te::plugin::PluginInfo &

pluginInfo

)

It creates a new C++ module.

te::grib::Platform::~Platform

(

)

destructor.

Member Function Documentation

static void te::grib::Platform::finalize ( )

static

It finalizes all TerraLib GRIB driver support.

Note

This function must be called once in your program. This must be the last call to TerraLib GRIB 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::grib::Platform::initialize ( )

static

It initializes all TerraLib GRIB 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

rhs	The right-hand-side plugin.

Returns

True if this plugin name is lexcographical less than the rhs plugin name.

void te::grib::Platform::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.

void te::grib::Platform::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.

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.

bool te::grib::Platform::sm_gribInitialized

static

A flag that indicates if the GRIB driver is initialized or not.

Definition at line 117 of file Platform.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/grib/Platform.h