MySQL  8.0.28
Source Code Documentation
is_valid.h
Go to the documentation of this file.
1 #ifndef SQL_GIS_IS_VALID_H_INCLUDED
2 #define SQL_GIS_IS_VALID_H_INCLUDED
3 
4 // Copyright (c) 2017, 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 to calculate if a geometry is valid
29 
30 #include "sql/dd/types/spatial_reference_system.h" // dd::Spatial_reference_system
31 #include "sql/gis/geometries.h"
32 
33 namespace gis {
34 
35 /// Decides if a geometry is valid.
36 ///
37 /// The SRS must match the SRS referenced by the geometry, this is the caller's
38 /// responsibility.
39 ///
40 /// @param[in] srs The spatial reference system.
41 /// @param[in] g The geometry
42 /// @param[in] func_name Function name used in error reporting.
43 /// @param[out] is_valid The validity of the geometry
44 ///
45 /// @retval false No error occurred
46 /// @retval true An error has occurred, the error has been reported with
47 /// my_error().
48 bool is_valid(const dd::Spatial_reference_system *srs, const Geometry *g,
49  const char *func_name, bool *is_valid) noexcept;
50 
51 } // namespace gis
52 
53 #endif // SQL_GIS_IS_VALID_H_INCLUDED
Definition: spatial.h:214
Definition: spatial_reference_system.h:52
This file declares the geometry class hierarchy used by the server as the internal representation of ...
Definition: area.cc:46
bool is_valid(const dd::Spatial_reference_system *srs, const Geometry *g, const char *func_name, bool *is_valid) noexcept
Decides if a geometry is valid.
Definition: is_valid.cc:94