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/wfs/Module.h
22 
23  \brief The TerraLib WFS driver as a plugin.
24 */
25 
26 #ifndef __TERRALIB_WFS_INTERNAL_MODULE_H
27 #define __TERRALIB_WFS_INTERNAL_MODULE_H
28 
29 // TerraLib
30 #include "../core/plugin/CppPlugin.h"
31 #include "Config.h"
32 
33 namespace te
34 {
35  namespace wfs
36  {
37  /*!
38  \class Module
39 
40  brief The TerraLib WFS driver as a plugin.
41  */
42  class Module : public te::core::CppPlugin
43  {
44  public:
45 
46  /*!
47  \brief Plugin constructor.
48 
49  \param pInfo Basic information provided to initialize this module through the plugin API.
50  */
51  Module(const te::core::PluginInfo& pluginInfo);
52 
53  /*! \brief Destructor. */
54  ~Module();
55 
56  //@}
57 
58  /** @name Re-Implmentation from Plugin Interface
59  * Re-Implementation from Plugin Interface.
60  */
61  //@{
62 
63  /*!
64  \brief This method will be called by TerraLib to startup some plugin's functionality.
65 
66  \exception Exception It throws an exception if the plugin can not be started.
67  */
68  void startup();
69 
70  /*!
71  \brief This method will be called by TerraLib to shutdown plugin's functionality.
72 
73  \exception Exception It throws an exception if the plugin can not be shutdown.
74  */
75  void shutdown();
76 
77  //@}
78  };
79 
80  } // end namespace wfs
81 } // end namespace te
82 
83 #endif // __TERRALIB_WFS_INTERNAL_MODULE_H
te
TerraLib.
Definition: AddressGeocodingOp.h:52
te::wfs::Module::shutdown
void shutdown()
This method will be called by TerraLib to shutdown plugin's functionality.
te::wfs::Module::Module
Module(const te::core::PluginInfo &pluginInfo)
Plugin constructor.
te::wfs::Module
Definition: Module.h:43
te::wfs::Module::~Module
~Module()
Destructor.
te::core::PluginInfo
Basic information about a plugin.
Definition: PluginInfo.h:64
te::core::CppPlugin
The base class for C++ plugins.
Definition: CppPlugin.h:47
te::wfs::Module::startup
void startup()
This method will be called by TerraLib to startup some plugin's functionality.
Config.h
Proxy configuration file for TerraView (see terraview_config.h).