GDAL

ogrmutexeddatasource.h
1 /******************************************************************************
2 * $Id$
3 *
4 * Project: OpenGIS Simple Features Reference Implementation
5 * Purpose: Defines OGRLMutexedDataSource class
6 * Author: Even Rouault, even dot rouault at spatialys.com
7 *
8 ******************************************************************************
9 * Copyright (c) 2013, Even Rouault <even dot rouault at spatialys.com>
10 *
11 * Permission is hereby granted, free of charge, to any person obtaining a
12 * copy of this software and associated documentation files (the "Software"),
13 * to deal in the Software without restriction, including without limitation
14 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15 * and/or sell copies of the Software, and to permit persons to whom the
16 * Software is furnished to do so, subject to the following conditions:
17 *
18 * The above copyright notice and this permission notice shall be included
19 * in all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
22 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27 * DEALINGS IN THE SOFTWARE.
28 ****************************************************************************/
29
30 #ifndef OGRMUTEXEDDATASOURCELAYER_H_INCLUDED
31 #define OGRMUTEXEDDATASOURCELAYER_H_INCLUDED
32
33 #ifndef DOXYGEN_SKIP
34
35 #include "ogrsf_frmts.h"
36 #include "cpl_multiproc.h"
37 #include "ogrmutexedlayer.h"
38 #include <map>
39
47 class CPL_DLL OGRMutexedDataSource : public OGRDataSource
48 {
49 CPL_DISALLOW_COPY_ASSIGN(OGRMutexedDataSource)
50
51 protected:
52 OGRDataSource *m_poBaseDataSource;
53 int m_bHasOwnership;
54 CPLMutex *m_hGlobalMutex;
55 int m_bWrapLayersInMutexedLayer;
56 std::map<OGRLayer *, OGRMutexedLayer *> m_oMapLayers{};
57 std::map<OGRMutexedLayer *, OGRLayer *> m_oReverseMapLayers{};
58
59 OGRLayer *WrapLayerIfNecessary(OGRLayer *poLayer);
60
61 public:
62 /* The construction of the object isn't protected by the mutex */
63 OGRMutexedDataSource(OGRDataSource *poBaseDataSource, int bTakeOwnership,
64 CPLMutex *hMutexIn, int bWrapLayersInMutexedLayer);
65
66 /* The destruction of the object isn't protected by the mutex */
67 virtual ~OGRMutexedDataSource() override;
68
69 OGRDataSource *GetBaseDataSource()
70 {
71 return m_poBaseDataSource;
72 }
73
74 virtual const char *GetName() override;
75
76 virtual int GetLayerCount() override;
77 virtual OGRLayer *GetLayer(int) override;
78 virtual OGRLayer *GetLayerByName(const char *) override;
79 virtual OGRErr DeleteLayer(int) override;
80 virtual bool IsLayerPrivate(int iLayer) const override;
81
82 virtual int TestCapability(const char *) override;
83
84 virtual OGRLayer *ICreateLayer(const char *pszName,
85 OGRSpatialReference *poSpatialRef = nullptr,
86 OGRwkbGeometryType eGType = wkbUnknown,
87 char **papszOptions = nullptr) override;
88 virtual OGRLayer *CopyLayer(OGRLayer *poSrcLayer, const char *pszNewName,
89 char **papszOptions = nullptr) override;
90
91 virtual OGRStyleTable *GetStyleTable() override;
92 virtual void SetStyleTableDirectly(OGRStyleTable *poStyleTable) override;
93
94 virtual void SetStyleTable(OGRStyleTable *poStyleTable) override;
95
96 virtual OGRLayer *ExecuteSQL(const char *pszStatement,
97 OGRGeometry *poSpatialFilter,
98 const char *pszDialect) override;
99 virtual void ReleaseResultSet(OGRLayer *poResultsSet) override;
100
101 virtual CPLErr FlushCache(bool bAtClosing) override;
102
103 virtual OGRErr StartTransaction(int bForce = FALSE) override;
104 virtual OGRErr CommitTransaction() override;
105 virtual OGRErr RollbackTransaction() override;
106
107 virtual char **GetMetadata(const char *pszDomain = "") override;
108 virtual CPLErr SetMetadata(char **papszMetadata,
109 const char *pszDomain = "") override;
110 virtual const char *GetMetadataItem(const char *pszName,
111 const char *pszDomain = "") override;
112 virtual CPLErr SetMetadataItem(const char *pszName, const char *pszValue,
113 const char *pszDomain = "") override;
114
115 virtual std::vector<std::string>
116 GetFieldDomainNames(CSLConstList papszOptions = nullptr) const override;
117 virtual const OGRFieldDomain *
118 GetFieldDomain(const std::string &name) const override;
119
120 virtual bool AddFieldDomain(std::unique_ptr<OGRFieldDomain> &&domain,
121 std::string &failureReason) override;
122 virtual bool DeleteFieldDomain(const std::string &name,
123 std::string &failureReason) override;
124 virtual bool UpdateFieldDomain(std::unique_ptr<OGRFieldDomain> &&domain,
125 std::string &failureReason) override;
126
127 std::vector<std::string>
128 GetRelationshipNames(CSLConstList papszOptions = nullptr) const override;
129
130 const GDALRelationship *
131 GetRelationship(const std::string &name) const override;
132
133 virtual std::shared_ptr<GDALGroup> GetRootGroup() const override;
134 };
135
136 #endif /* #ifndef DOXYGEN_SKIP */
137
138 #endif // OGRMUTEXEDDATASOURCELAYER_H_INCLUDED
GDALDataset::StartTransaction
virtual OGRErr StartTransaction(int bForce=FALSE)
For datasources which support transactions, StartTransaction creates a `transaction.
Definition: gdaldataset.cpp:7476
GDALDataset::GetFieldDomainNames
virtual std::vector< std::string > GetFieldDomainNames(CSLConstList papszOptions=nullptr) const
Returns a list of the names of all field domains stored in the dataset.
Definition: gdaldataset.cpp:8543
OGRStyleTable
This class represents a style table.
Definition: ogr_featurestyle.h:84
GDALDataset::GetRootGroup
virtual std::shared_ptr< GDALGroup > GetRootGroup() const
Return the root GDALGroup of this dataset.
Definition: gdaldataset.cpp:8460
OGRSpatialReference
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:166
GDALDataset::GetLayer
virtual OGRLayer * GetLayer(int iLayer)
Fetch a layer by index.
Definition: gdaldataset.cpp:7009
OGRGeometry
Abstract base class for all geometry classes.
Definition: ogr_geometry.h:334
OGRLayer
This class represents a layer of simple features, with access methods.
Definition: ogrsf_frmts.h:72
GDALDataset::GetMetadata
void static void char ** GetMetadata(const char *pszDomain="") override
Fetch metadata.
Definition: gdaldataset.cpp:4280
GDALDataset::GetRelationshipNames
virtual std::vector< std::string > GetRelationshipNames(CSLConstList papszOptions=nullptr) const
Returns a list of the names of all relationships stored in the dataset.
Definition: gdaldataset.cpp:8866
GDALDataset::CopyLayer
virtual OGRLayer * CopyLayer(OGRLayer *poSrcLayer, const char *pszNewName, char **papszOptions=nullptr)
Duplicate an existing layer.
Definition: gdaldataset.cpp:5166
GDALMajorObject::GetMetadataItem
virtual const char * GetMetadataItem(const char *pszName, const char *pszDomain="")
Fetch single metadata item.
Definition: gdalmajorobject.cpp:341
GDALDataset::ReleaseResultSet
virtual void ReleaseResultSet(OGRLayer *poResultsSet)
Release results of ExecuteSQL().
Definition: gdaldataset.cpp:6873
GDALRelationship
Definition of a table relationship.
Definition: gdal_priv.h:3166
GDALDataset::CommitTransaction
virtual OGRErr CommitTransaction()
For datasources which support transactions, CommitTransaction commits a transaction.
Definition: gdaldataset.cpp:7566
GDALDataset::ExecuteSQL
virtual OGRLayer * ExecuteSQL(const char *pszStatement, OGRGeometry *poSpatialFilter, const char *pszDialect)
Execute an SQL statement against the data store.
Definition: gdaldataset.cpp:6316
GDALDataset::GetStyleTable
virtual OGRStyleTable * GetStyleTable()
Returns dataset style table.
Definition: gdaldataset.cpp:6895
GDALDataset::UpdateFieldDomain
virtual bool UpdateFieldDomain(std::unique_ptr< OGRFieldDomain > &&domain, std::string &failureReason)
Updates an existing field domain by replacing its definition.
Definition: gdaldataset.cpp:8798
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1195
GDALDataset::DeleteFieldDomain
virtual bool DeleteFieldDomain(const std::string &name, std::string &failureReason)
Removes a field domain from the dataset.
Definition: gdaldataset.cpp:8728
ogrsf_frmts.h
GDALDataset::AddFieldDomain
virtual bool AddFieldDomain(std::unique_ptr< OGRFieldDomain > &&domain, std::string &failureReason)
Add a field domain to the dataset.
Definition: gdaldataset.cpp:8649
GDALDataset::GetLayerByName
virtual OGRLayer * GetLayerByName(const char *)
Fetch a layer by name.
Definition: gdaldataset.cpp:5559
GDALDataset::GetRelationship
virtual const GDALRelationship * GetRelationship(const std::string &name) const
Get a relationship from its name.
Definition: gdaldataset.cpp:8910
OGRDataSource
LEGACY class.
Definition: ogrsf_frmts.h:455
OGRFieldDomain
Definition of a field domain.
Definition: ogr_feature.h:1341
OGRErr
int OGRErr
Type for a OGR error.
Definition: ogr_core.h:378
GDALDataset::IsLayerPrivate
virtual bool IsLayerPrivate(int iLayer) const
Returns true if the layer at the specified index is deemed a private or system table,...
Definition: gdaldataset.cpp:7032
OGRwkbGeometryType
OGRwkbGeometryType
List of well known binary geometry types.
Definition: ogr_core.h:406
GDALDataset::GetLayerCount
virtual int GetLayerCount()
Get the number of layers in this dataset.
Definition: gdaldataset.cpp:6979
GDALDataset::SetMetadataItem
CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain) override
Set single metadata item.
CPLErr
CPLErr
Error category.
Definition: cpl_error.h:52
GDALDataset::ICreateLayer
virtual OGRLayer * ICreateLayer(const char *pszName, OGRSpatialReference *poSpatialRef=nullptr, OGRwkbGeometryType eGType=wkbUnknown, char **papszOptions=nullptr)
This method attempts to create a new layer on the dataset with the indicated name,...
Definition: gdaldataset.cpp:5123
GDALDataset::SetMetadata
CPLErr SetMetadata(char **papszMetadata, const char *pszDomain) override
Set metadata.
GDALDataset::SetStyleTableDirectly
virtual void SetStyleTableDirectly(OGRStyleTable *poStyleTable)
Set dataset style table.
Definition: gdaldataset.cpp:6918
GDALDataset::RollbackTransaction
virtual OGRErr RollbackTransaction()
For datasources which support transactions, RollbackTransaction will roll back a datasource to its st...
Definition: gdaldataset.cpp:7621
GDALDataset::TestCapability
virtual int TestCapability(const char *)
Test if capability is available.
Definition: gdaldataset.cpp:7368
GDALDataset::GetFieldDomain
virtual const OGRFieldDomain * GetFieldDomain(const std::string &name) const
Get a field domain from its name.
Definition: gdaldataset.cpp:8593
GDALDataset::SetStyleTable
virtual void SetStyleTable(OGRStyleTable *poStyleTable)
Set dataset style table.
Definition: gdaldataset.cpp:6944
wkbUnknown
@ wkbUnknown
unknown type, non-standard
Definition: ogr_core.h:408
CPL_DISALLOW_COPY_ASSIGN
#define CPL_DISALLOW_COPY_ASSIGN(ClassName)
Helper to remove the copy and assignment constructors so that the compiler will not generate the defa...
Definition: cpl_port.h:1051
GDALDataset::FlushCache
virtual CPLErr FlushCache(bool bAtClosing=false)
Flush all write cached data to disk.
Definition: gdaldataset.cpp:519
GDALDataset::DeleteLayer
virtual OGRErr DeleteLayer(int iLayer)
Delete the indicated layer from the datasource.
Definition: gdaldataset.cpp:5530