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/ado/Module.h
22 
23  \brief A utility class to initialize and terminate TerraLib ADO driver support.
24 */
25 
26 #ifndef __TERRALIB_ADO_INTERNAL_MODULE_H
27 #define __TERRALIB_ADO_INTERNAL_MODULE_H
28 
29 // TerraLib
30 #include "../core/plugin/CppPlugin.h"
31 #include "Config.h"
32 
33 namespace te
34 {
35  namespace ado
36  {
37  /*!
38  \class Platform
39 
40  \brief A utility class to initialize and terminate TerraLib ADO driver support.
41 
42  \sa te::plugin::Plugin
43  */
44  class Module : public te::core::CppPlugin
45  {
46  public:
47 
48  /** @name Initializer Methods
49  * Constructor/Destructor.
50  */
51  //@{
52 
53  /*! \brief It creates a new C++ module. */
54  Module(const te::core::PluginInfo& pluginInfo);
55 
56  /*! \brief Destructor. */
57  ~Module();
58 
59  //@}
60 
61  /** @name Re-Implmentation from Plugin Interface
62  * Re-Implementation from Plugin Interface.
63  */
64  //@{
65 
66  /*!
67  \brief This method will be called by TerraLib to startup some plugin's functionality.
68 
69  \exception Exception It throws an exception if the plugin can not be started.
70  */
71  void startup();
72 
73  /*!
74  \brief This method will be called by TerraLib to shutdown plugin's functionality.
75 
76  \exception Exception It throws an exception if the plugin can not be shutdown.
77  */
78  void shutdown();
79  //@}
80 
81 
82  static const std::string sm_unknownTypeName; //!< The string literal representation for the unknown type.
83  static const std::string sm_int2TypeName; //!< The string literal representation for the int2 type
84  static const std::string sm_intTypeName; //!< The string literal representation for the int type
85  static const std::string sm_int8TypeName; //!< The string literal representation for the int8 type
86  static const std::string sm_numericTypeName; //!< The string literal representation for the numeric type
87  static const std::string sm_dateTypeName; //!< The string literal representation for the date type
88  static const std::string sm_timeTypeName; //!< The string literal representation for the time type
89  static const std::string sm_timeTZTypeName; //!< The string literal representation for the time type
90  static const std::string sm_timeStampTypeName; //!< The string literal representation for the time stamp type
91  static const std::string sm_timeStampTZTypeName; //!< The string literal representation for the time stamp with time zone type
92  static const std::string sm_floatTypeName; //!< The string literal representation for the float type
93  static const std::string sm_doubleTypeName; //!< The string literal representation for the double type
94  static const std::string sm_booleanTypeName; //!< The string literal representation for the boolean type
95  static const std::string sm_charTypeName; //!< The string literal representation for the char type
96  static const std::string sm_varcharTypeName; //!< The string literal representation for the varchar type
97  static const std::string sm_stringTypeName; //!< The string literal representation for the string type
98  static const std::string sm_byteArrayTypeName; //!< The string literal representation for the byte array type
99  static const std::string sm_pointTypeName; //!< The string literal representation for ADO point geometry type
100  static const std::string sm_pointMTypeName; //!< The string literal representation for ADO point geometry type
101  static const std::string sm_lineStringTypeName; //!< The string literal representation for ADO line string geometry type
102  static const std::string sm_lineStringMTypeName; //!< The string literal representation for ADO line string with m geometry type
103  static const std::string sm_polygonTypeName; //!< The string literal representation for ADO polygon geometry type
104  static const std::string sm_polygonMTypeName; //!< The string literal representation for ADO polygon with m geometry type
105  static const std::string sm_geometryCollectionTypeName; //!< The string literal representation for ADO geometry collection geometry type
106  static const std::string sm_geometryCollectionMTypeName; //!< The string literal representation for ADO geometry collection with m geometry type
107  static const std::string sm_multiPointTypeName; //!< The string literal representation for ADO multi-point geometry type
108  static const std::string sm_multiPointMTypeName; //!< The string literal representation for ADO multi-point with m geometry type
109  static const std::string sm_multiLineStringTypeName; //!< The string literal representation for ADO multi-linestring geometry type
110  static const std::string sm_multiLineStringMTypeName; //!< The string literal representation for ADO multi-linestring with m geometry type
111  static const std::string sm_multiPolygonTypeName; //!< The string literal representation for ADO multi-polygon geometry type
112  static const std::string sm_multiPolygonMTypeName; //!< The string literal representation for ADO multi-polygon with m geometry type
113  static const std::string sm_geometryTypeName; //!< The string literal representation for ADO base geometry type
114  };
115  } // end namespace ado
116 } // end namespace te
117 
118 #endif // __TERRALIB_ADO_INTERNAL_MODULE_H
119 
static const std::string sm_floatTypeName
The string literal representation for the float type.
Definition: Module.h:92
static const std::string sm_pointMTypeName
The string literal representation for ADO point geometry type.
Definition: Module.h:100
static const std::string sm_timeStampTZTypeName
The string literal representation for the time stamp with time zone type.
Definition: Module.h:91
static const std::string sm_geometryCollectionTypeName
The string literal representation for ADO geometry collection geometry type.
Definition: Module.h:105
static const std::string sm_unknownTypeName
The string literal representation for the unknown type.
Definition: Module.h:82
static const std::string sm_timeStampTypeName
The string literal representation for the time stamp type.
Definition: Module.h:90
static const std::string sm_int8TypeName
The string literal representation for the int8 type.
Definition: Module.h:85
static const std::string sm_multiLineStringTypeName
The string literal representation for ADO multi-linestring geometry type.
Definition: Module.h:109
void shutdown()
This method will be called by TerraLib to shutdown plugin's functionality.
static const std::string sm_charTypeName
The string literal representation for the char type.
Definition: Module.h:95
static const std::string sm_intTypeName
The string literal representation for the int type.
Definition: Module.h:84
static const std::string sm_geometryTypeName
The string literal representation for ADO base geometry type.
Definition: Module.h:113
Configuration flags for the TerraLib ADO Data Access driver.
static const std::string sm_polygonMTypeName
The string literal representation for ADO polygon with m geometry type.
Definition: Module.h:104
Basic information about a plugin.
Definition: PluginInfo.h:63
static const std::string sm_lineStringMTypeName
The string literal representation for ADO line string with m geometry type.
Definition: Module.h:102
static const std::string sm_booleanTypeName
The string literal representation for the boolean type.
Definition: Module.h:94
static const std::string sm_byteArrayTypeName
The string literal representation for the byte array type.
Definition: Module.h:98
void startup()
This method will be called by TerraLib to startup some plugin's functionality.
static const std::string sm_int2TypeName
The string literal representation for the int2 type.
Definition: Module.h:83
~Module()
Destructor.
static const std::string sm_polygonTypeName
The string literal representation for ADO polygon geometry type.
Definition: Module.h:103
The base class for C++ plugins.
Definition: CppPlugin.h:46
URI C++ Library.
static const std::string sm_numericTypeName
The string literal representation for the numeric type.
Definition: Module.h:86
static const std::string sm_timeTZTypeName
The string literal representation for the time type.
Definition: Module.h:89
static const std::string sm_pointTypeName
The string literal representation for ADO point geometry type.
Definition: Module.h:99
static const std::string sm_lineStringTypeName
The string literal representation for ADO line string geometry type.
Definition: Module.h:101
static const std::string sm_multiPointTypeName
The string literal representation for ADO multi-point geometry type.
Definition: Module.h:107
static const std::string sm_geometryCollectionMTypeName
The string literal representation for ADO geometry collection with m geometry type.
Definition: Module.h:106
static const std::string sm_multiPolygonMTypeName
The string literal representation for ADO multi-polygon with m geometry type.
Definition: Module.h:112
static const std::string sm_dateTypeName
The string literal representation for the date type.
Definition: Module.h:87
static const std::string sm_stringTypeName
The string literal representation for the string type.
Definition: Module.h:97
Module(const te::core::PluginInfo &pluginInfo)
It creates a new C++ module.
static const std::string sm_timeTypeName
The string literal representation for the time type.
Definition: Module.h:88
static const std::string sm_multiLineStringMTypeName
The string literal representation for ADO multi-linestring with m geometry type.
Definition: Module.h:110
static const std::string sm_doubleTypeName
The string literal representation for the double type.
Definition: Module.h:93
static const std::string sm_multiPolygonTypeName
The string literal representation for ADO multi-polygon geometry type.
Definition: Module.h:111
static const std::string sm_multiPointMTypeName
The string literal representation for ADO multi-point with m geometry type.
Definition: Module.h:108
static const std::string sm_varcharTypeName
The string literal representation for the varchar type.
Definition: Module.h:96