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 Module.h
22 
23  \brief This singleton defines the TerraLib Qt Widgets module entry.
24 */
25 
26 #ifndef __TERRALIB_ADDRESSGEOCODING_CORE_INTERNAL_MODULE_H
27 #define __TERRALIB_ADDRESSGEOCODING_CORE_INTERNAL_MODULE_H
28 
29 // TerraLib
30 #include "../common/Singleton.h"
31 
32 #include <memory>
33 
34 namespace te
35 {
36  namespace addressgeocoding
37  {
38  /*!
39  \class Module
40 
41  \brief This singleton defines the TerraLib Qt Widgets module entry.
42  */
43  class Module : public te::common::Singleton<Module>
44  {
45  friend class te::common::Singleton<Module>;
46 
47  protected:
48 
49  /*! \brief The singleton constructor is not callable outside the class. */
50  Module();
51 
52  /* \brief Destructor. */
54 
55  private:
56 
57  /*!
58  \brief This is the startup function for the TerraLib Qt Widgets module.
59 
60  \note This method doesn't perform operations for this module.
61  */
62  static void initialize();
63 
64  /*!
65  \brief This is the cleanup function for the TerraLib Qt Widgets module.
66 
67  \note This method doesn't perform operations for this module.
68  */
69  static void finalize();
70 
71 
72  std::shared_ptr<TerraLib::Module> m_module;
73  };
74  } // end namespace qt
75 } // end namespace te
76 
77 #endif // __TERRALIB_ADDRESSGEOCODING_CORE_INTERNAL_MODULE_H
78 
This singleton defines the TerraLib Qt Widgets module entry.
Definition: Module.h:44
static void finalize()
This is the cleanup function for the TerraLib Qt Widgets module.
std::shared_ptr< TerraLib::Module > m_module
Definition: Module.h:72
static void initialize()
This is the startup function for the TerraLib Qt Widgets module.
Module()
The singleton constructor is not callable outside the class.
Template support for singleton pattern.
Definition: Singleton.h:101
TerraLib.