Module.cpp
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/gdal/Module.h
22 
23  \brief The TerraLib OGR driver is a plugin.
24 */
25 
26 // TerraLib
27 #include "../BuildConfig.h"
28 #include "../common/Logger.h"
29 #include "../plugin/PluginInfo.h"
30 #include "../common/Translator.h"
31 #include "../common/PlatformUtils.h"
32 #include "../Defines.h"
33 #include "../dataaccess/datasource/DataSourceCapabilities.h"
34 #include "../dataaccess/datasource/DataSourceFactory.h"
35 #include "../dataaccess/datasource/DataSourceManager.h"
36 #include "Config.h"
37 #include "DataSourceFactory.h"
38 #include "Module.h"
39 #include "RasterFactory.h"
40 #include "Utils.h"
41 
42 // STL
43 #include <cstdlib>
44 
45 // GDAL
46 #include <gdal_priv.h>
47 
49  : te::plugin::Plugin(pluginInfo)
50 {
51 }
52 
54 {
55 }
56 
58 {
59  if(m_initialized)
60  return;
61 
62 // for all platforms, first look at TERRALIB_GDAL_DATA detected by CMAKE
63 // note: installed versions on developers machine may look for this version of GDAL
64  std::string gdal_data_dir(TERRALIB_GDAL_DATA);
65 
66  if(gdal_data_dir.empty())
67  {
68 // search for GDAL in TerraLib PATH
69 #if TE_PLATFORM == TE_PLATFORMCODE_MSWINDOWS
70  gdal_data_dir = te::common::FindInTerraLibPath("/share/data");
71 #elif TE_PLATFORM == TE_PLATFORMCODE_APPLE
72  gdal_data_dir = te::common::FindInTerraLibPath("/share/gdal");
73 #elif TE_PLATFORM == TE_PLATFORMCODE_LINUX
74  gdal_data_dir= te::common::FindInTerraLibPath("/share/gdal");
75 #else
76  #error "unsupported plataform: please, contact terralib-team@terralib.org"
77 #endif
78  }
79 
80  if(!gdal_data_dir.empty())
81  {
82  CPLSetConfigOption("GDAL_DATA", gdal_data_dir.c_str());
83  }
84 
85  CPLSetConfigOption("GDAL_PAM_ENABLED", "NO");
86 
88 
89  GDALAllRegister();
90 
92 
93  // DataType Capabilites
95  dataTypeCapabilities.setSupportRaster(true);
96 
97  // DataSetType Capabilites
99 
100  // DataSet Capabilities
102  dataSetCapabilities.setSupportEfficientDataSetSize(true);
103 
104  // Query Capabilities
106 
107  // DataSouce Capabilities
109  capabilities.setSupportAll();
110  capabilities.setSupportTransactions(false);
111  capabilities.setDataTypeCapabilities(dataTypeCapabilities);
112  capabilities.setDataSetTypeCapabilities(dataSetTypeCapabilities);
113  capabilities.setDataSetCapabilities(dataSetCapabilities);
114  capabilities.setQueryCapabilities(queryCapabilities);
116 
117  // Supported file extensions capability
118 
119  std::set< std::string > supportedExtensionsSet;
120  for( std::map< std::string, DriverMetadata >::const_iterator it =
121  GetGDALDriversMetadata().begin() ; it !=
122  GetGDALDriversMetadata().end() ; ++it )
123  {
124  if( !it->second.m_extension.empty() )
125  {
126  if( supportedExtensionsSet.find( it->second.m_extension ) ==
127  supportedExtensionsSet.end() )
128  {
129  supportedExtensionsSet.insert( it->second.m_extension );
130  }
131  }
132  }
133 
134  std::string supportedExtensionsStr;
135  for( std::set< std::string >::const_iterator it = supportedExtensionsSet.begin() ;
136  it != supportedExtensionsSet.end() ; ++it )
137  {
138  if( !supportedExtensionsStr.empty() )
139  {
140  supportedExtensionsStr.append( ";" );
141  }
142  supportedExtensionsStr.append( *it );
143  }
144 
145  capabilities.addSpecificCapability( "SUPPORTED_EXTENSIONS", supportedExtensionsStr );
146 
148 
149  // initializing the static mutex
150  getStaticMutex();
151 
152  TE_LOG_TRACE(TE_TR("TerraLib GDAL driver startup!"));
153 
154  m_initialized = true;
155 }
156 
158 {
159  if(!m_initialized)
160  return;
161 
162 //! it finalizes the GDAL factory support.
164 
166 
167 //! free GDAL registered drivers
169 
170  TE_LOG_TRACE(TE_TR("TerraLib GDAL driver shutdown!"));
171 
172  m_initialized = false;
173 }
174 
176 
#define TE_LOG_TRACE(msg)
Use this tag in order to log a message to a specified logger with the TRACE level.
Definition: Logger.h:137
A class that informs what kind of constraint and index is supported by a given data source...
void startup()
This method will be called by TerraLib to startup some plugin's functionality.
Definition: Module.cpp:57
Utilitary functions to access GDAL and match some of its concepts to TerraLib concepts.
TECOMMONEXPORT std::string FindInTerraLibPath(const std::string &p)
Returns the path relative to a directory or file in the context of TerraLib.
void setDataSetTypeCapabilities(const DataSetTypeCapabilities &capabilities)
void addSpecificCapability(const std::string &key, const std::string &value)
static void initialize()
It initializes the factory: the singleton instance will be registered in the abstract factory DataSou...
const std::map< std::string, DriverMetadata > & GetGDALDriversMetadata()
Returns metadata from all registered GDAL drivers (key: driver name).
Definition: Utils.cpp:918
static void setCapabilities(const te::da::DataSourceCapabilities &capabilities)
Definition: DataSource.cpp:155
te::da::QueryCapabilities queryCapabilities
A class that represents the known capabilities of a specific data source, i.e. this class informs all...
void setAccessPolicy(const te::common::AccessPolicy &accessPolicy)
Module(const te::plugin::PluginInfo &pluginInfo)
Plugin constructor.
Definition: Module.cpp:48
~Module()
Destructor.
Definition: Module.cpp:53
A class that informs what the dataset implementation of a given data source can perform.
#define TE_TR(message)
It marks a string in order to get translated.
Definition: Translator.h:346
te::da::DataSource * Build()
void setQueryCapabilities(const QueryCapabilities &capabilities)
te::da::DataSetTypeCapabilities dataSetTypeCapabilities
#define TE_GDAL_DRIVER_IDENTIFIER
Definition: Config.h:36
void setSupportTransactions(const bool &support)
A class that represents the supported data types of a specific data source.
te::da::DataTypeCapabilities dataTypeCapabilities
#define PLUGIN_CALL_BACK_IMPL(PLUGIN_CLASS_NAME)
This macro should be used by C++ plugins in order to declare the exportable/callable DLL function...
Definition: Config.h:54
A class that informs the query support of a given data source.
void shutdown()
This method will be called by TerraLib to shutdown plugin's functionality.
Definition: Module.cpp:157
static DataSourceManager & getInstance()
It returns a reference to the singleton instance.
te::da::DataSourceCapabilities capabilities
URI C++ Library.
void setSupportRaster(const bool &support)
The TerraLib GDAL driver is a plugin.
Definition: Module.h:42
te::da::DataSetCapabilities dataSetCapabilities
void setDataSetCapabilities(const DataSetCapabilities &capabilities)
This is the concrete factory for GDAL rasters.
A factory for data sources.
void setDataTypeCapabilities(const DataTypeCapabilities &capabilities)
static void add(const std::string &dsType, FactoryFnctType f)
static void finalize()
It finalizes the factory: the singleton instance will be destroyed and will be unregistered from the ...
The basic information about a plugin.
Definition: PluginInfo.h:61
static void remove(const std::string &dsType)
TEGDALEXPORT boost::mutex & getStaticMutex()
Returns a reference to a static mutex initialized when this module is initialized.
Definition: Utils.cpp:912
The TerraLib OGR driver is a plugin.
Configuration flags for the GDAL Driver of TerraLib.
void setSupportEfficientDataSetSize(const bool &support)