Module.h
Go to the documentation of this file.
1 /* Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
2 
3  This file is part of the TerraLib - a Framework for building GIS enabled applications.
4 
5  TerraLib is free software: you can redistribute it and/or modify
6  it under the terms of the GNU Lesser General Public License as published by
7  the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  TerraLib is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public License
16  along with TerraLib. See COPYING. If not, write to
17  TerraLib Team at <terralib-team@terralib.org>.
18  */
19 
20 /*!
21  \file terralib/terralib4/Module.h
22 
23  \brief A utility class to initialize and terminate TerraLib 4 driver support.
24 */
25 
26 #ifndef __TERRALIB_TERRALIB4_INTERNAL_MODULE_H
27 #define __TERRALIB_TERRALIB4_INTERNAL_MODULE_H
28 
29 // TerraLib
30 #include "../plugin/Plugin.h"
31 #include "Config.h"
32 
33 namespace terralib4
34 {
35  /*!
36  \class Platform
37 
38  \brief A utility class to initialize and terminate TerraLib 4 driver support.
39 
40  \sa te::plugin::Plugin
41  */
42  class Module : public te::plugin::Plugin
43  {
44  public:
45 
46  /** @name Initializer Methods
47  * Constructor/Destructor.
48  */
49  //@{
50 
51  /*! \brief It creates a new C++ module. */
52  Module(const te::plugin::PluginInfo& pluginInfo);
53 
54  /*! \brief Destructor. */
55  ~Module();
56 
57  //@}
58 
59  /** @name Re-Implmentation from Plugin Interface
60  * Re-Implementation from Plugin Interface.
61  */
62  //@{
63 
64  /*!
65  \brief This method will be called by TerraLib to startup some plugin's functionality.
66 
67  \exception Exception It throws an exception if the plugin can not be started.
68  */
69  void startup();
70 
71  /*!
72  \brief This method will be called by TerraLib to shutdown plugin's functionality.
73 
74  \exception Exception It throws an exception if the plugin can not be shutdown.
75  */
76  void shutdown();
77  //@}
78 
79  };
80 } // end namespace terralib4
81 
83 
84 #endif // __TERRALIB_TERRALIB4_INTERNAL_MODULE_H
85 
Configuration flags for the TerraLib 4 driver.
PLUGIN_CALL_BACK_DECLARATION(TEADOEXPORT)
Definition: Band.h:34
Module(const te::plugin::PluginInfo &pluginInfo)
It creates a new C++ module.
void startup()
This method will be called by TerraLib to startup some plugin's functionality.
void shutdown()
This method will be called by TerraLib to shutdown plugin's functionality.
A base class for plugin types.
Definition: Plugin.h:50
~Module()
Destructor.
#define TETERRALIB4EXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:123
The basic information about a plugin.
Definition: PluginInfo.h:61