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 Spatial Reference System module entry.
24  */
25 
26 #ifndef __TERRALIB_SRS_INTERNAL_MODULE_H
27 #define __TERRALIB_SRS_INTERNAL_MODULE_H
28 
29 // TerraLib
30 #include "../common/Singleton.h"
31 
32 // STL
33 #include <string>
34 
35 // Boost
36 #include <boost/thread/mutex.hpp>
37 
38 namespace te
39 {
40  namespace srs
41  {
42  /*!
43  \class Module
44 
45  \brief This singleton defines the TerraLib Spatial Reference System module entry.
46  */
47  class Module : public te::common::Singleton<Module>
48  {
50 
51  protected:
52 
53  //! Constructor. A singleton constructor is not callable outside the class.
54  Module();
55 
56  //! Destructor.
57  ~Module();
58 
59  private:
60 
61  /*!
62  \brief This is the startup function for the TerraLib SRS module.
63 
64  \note This method doesn't perform operations for this module.
65  */
66  static void initialize();
67 
68  /*!
69  \brief This is the cleanup function for the TerraLib SRS module.
70 
71  \note This method doesn't perform operations for this module.
72  */
73  static void finalize();
74 
75  static const Module& sm_module; //!< Just to make a static initialization.
76 
77  };
78 
79  /*!
80  \brief Returns a reference to a static mutex initialized when this module is initialized.
81  \return Returns a reference to a static mutex initialized when this module is initialized.
82  */
83  TESRSEXPORT boost::mutex& getStaticMutex();
84  } // end namespace srs
85 } // end namespace te
86 
87 #endif // __TERRALIB_SRS_INTERNAL_MODULE_H
88 
TESRSEXPORT boost::mutex & getStaticMutex()
Returns a reference to a static mutex initialized when this module is initialized.
static void initialize()
This is the startup function for the TerraLib SRS module.
static void finalize()
This is the cleanup function for the TerraLib SRS module.
static const Module & sm_module
Just to make a static initialization.
Definition: Module.h:75
This singleton defines the TerraLib Spatial Reference System module entry.
Definition: Module.h:47
URI C++ Library.
~Module()
Destructor.
Module()
Constructor. A singleton constructor is not callable outside the class.
#define TESRSEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:364
Template support for singleton pattern.
Definition: Singleton.h:100