MySQL  8.0.28
Source Code Documentation
buffer.h
Go to the documentation of this file.
1 #ifndef SQL_GIS_BUFFER_H_INCLUDED
2 #define SQL_GIS_BUFFER_H_INCLUDED
3 
4 // Copyright (c) 2021, Oracle and/or its affiliates.
5 //
6 // This program is free software; you can redistribute it and/or modify
7 // it under the terms of the GNU General Public License, version 2.0,
8 // as published by the Free Software Foundation.
9 //
10 // This program is also distributed with certain software (including
11 // but not limited to OpenSSL) that is licensed under separate terms,
12 // as designated in a particular file or component or in included license
13 // documentation. The authors of MySQL hereby grant you an additional
14 // permission to link the program and your derivative works with the
15 // separately licensed software that they have included with MySQL.
16 //
17 // This program is distributed in the hope that it will be useful,
18 // but WITHOUT ANY WARRANTY; without even the implied warranty of
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 // GNU General Public License, version 2.0, for more details.
21 //
22 // You should have received a copy of the GNU General Public License
23 // along with this program; if not, write to the Free Software
24 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 
26 /// @file
27 ///
28 /// This file declares the interface for calculating the buffer of a geometry.
29 
30 #include <memory> // std::unique_ptr
31 #include "sql/dd/types/spatial_reference_system.h" // dd::Spatial_reference_system
32 #include "sql/gis/buffer_strategies.h" // buffer_strategies
33 #include "sql/gis/geometries.h" // gis::Geometry
34 
35 namespace gis {
36 
37 /// Invalid buffer strategies exception.
38 ///
39 /// Thrown when a buffer strategy is given as argument and the geometry is not
40 /// compatible: e.g. point strategy with a Linestring. Also thrown when
41 /// distance is negative and geometry is not Multi-/Polygon or GC.
42 struct invalid_buffer_argument_exception : public std::exception {};
43 
44 /// Invalid buffer result exception.
45 ///
46 /// Thrown when the result from buffer call to Boost is invalid.
47 struct invalid_buffer_result_exception : public std::exception {};
48 
49 /// Creates the buffer of a geometry
50 ///
51 /// @param[in] srs The spatial reference system.
52 /// @param[in] g Input geomtry.
53 /// @param[in] strategies Struct holding strategy arguments for buffer creation
54 /// @param[in] func_name Function name used in error reporting.
55 /// @param[out] result The geometry that is the buffer of input geometry g
56 ///
57 /// @retval false Success.
58 /// @retval true An error has occurred. The error has been reported with
59 /// my_error().
60 
61 bool buffer(const dd::Spatial_reference_system *srs, const Geometry &g,
62  const BufferStrategies &strategies, const char *func_name,
63  std::unique_ptr<Geometry> *result) noexcept;
64 
65 } // namespace gis
66 
67 #endif // SQL_GIS_BUFFER_H_INCLUDED
This file implements a struct that is used to hold information that decide how to compute the buffer ...
Definition: spatial_reference_system.h:52
Abstract superclass for all geometric objects.
Definition: geometries.h:99
This file declares the geometry class hierarchy used by the server as the internal representation of ...
Definition: area.cc:46
bool buffer(const dd::Spatial_reference_system *srs, const Geometry &g, const BufferStrategies &strategies, const char *func_name, std::unique_ptr< Geometry > *result) noexcept
Creates the buffer of a geometry.
Definition: buffer.cc:320
Definition: buffer_strategies.h:44
Invalid buffer strategies exception.
Definition: buffer.h:42
Invalid buffer result exception.
Definition: buffer.h:47
Definition: result.h:29