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/datatype/Module.h
22 
23  \brief This singleton defines the TerraLib Data Type module entry.
24 */
25 
26 #ifndef __TERRALIB_DATATYPE_INTERNAL_MODULE_H
27 #define __TERRALIB_DATATYPE_INTERNAL_MODULE_H
28 
29 // TerraLib
30 #include "../common/Singleton.h"
31 
32 namespace te
33 {
34  namespace dt
35  {
36  /*!
37  \class Module
38 
39  \brief This singleton defines the TerraLib Data Type module entry.
40  */
41  class Module : public te::common::Singleton<Module>
42  {
44 
45  protected:
46 
47  /*! \brief The singleton constructor is not callable outside the class. */
48  Module();
49 
50  /* \brief Destructor. */
51  ~Module();
52 
53  private:
54 
55  /*!
56  \brief This is the startup function for the TerraLib DataType module.
57 
58  \note This method doesn't perform operations for this module.
59  */
60  static void initialize();
61 
62  /*!
63  \brief This is the cleanup function for the TerraLib DataType module.
64 
65  \note This method doesn't perform operations for this module.
66  */
67  static void finalize();
68 
69  private:
70 
71  static const Module& sm_module; //!< Just to make a static initialization.
72  };
73 
74  } // end namespace dt
75 } // end namespace te
76 
77 #endif // __TERRALIB_DATATYPE_INTERNAL_MODULE_H
78 
Module()
The singleton constructor is not callable outside the class.
static void initialize()
This is the startup function for the TerraLib DataType module.
URI C++ Library.
static const Module & sm_module
Just to make a static initialization.
Definition: Module.h:71
static void finalize()
This is the cleanup function for the TerraLib DataType module.
This singleton defines the TerraLib Data Type module entry.
Definition: Module.h:41
Template support for singleton pattern.
Definition: Singleton.h:100