MySQL
8.4.0
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, 2024, 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 designed to work 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 either included with
16
// the program or referenced in the documentation.
17
//
18
// This program is distributed in the hope that it will be useful,
19
// but WITHOUT ANY WARRANTY; without even the implied warranty of
20
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21
// GNU General Public License, version 2.0, for more details.
22
//
23
// You should have received a copy of the GNU General Public License
24
// along with this program; if not, write to the Free Software
25
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
26
27
/// @file
28
///
29
/// This file declares the interface to calculate if a geometry is valid
30
31
#include "
sql/dd/types/spatial_reference_system.h
"
// dd::Spatial_reference_system
32
#include "
sql/gis/geometries.h
"
33
34
namespace
gis
{
35
36
/// Decides if a geometry is valid.
37
///
38
/// The SRS must match the SRS referenced by the geometry, this is the caller's
39
/// responsibility.
40
///
41
/// @param[in] srs The spatial reference system.
42
/// @param[in] g The geometry
43
/// @param[in] func_name Function name used in error reporting.
44
/// @param[out] is_valid The validity of the geometry
45
///
46
/// @retval false No error occurred
47
/// @retval true An error has occurred, the error has been reported with
48
/// my_error().
49
bool
is_valid
(
const
dd::Spatial_reference_system
*srs,
const
Geometry
*g,
50
const
char
*func_name,
bool
*
is_valid
)
noexcept
;
51
52
}
// namespace gis
53
54
#endif
// SQL_GIS_IS_VALID_H_INCLUDED
Geometry
Definition:
spatial.h:213
dd::Spatial_reference_system
Definition:
spatial_reference_system.h:53
geometries.h
This file declares the geometry class hierarchy used by the server as the internal representation of ...
gis
Definition:
area.cc:47
gis::is_valid
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:95
spatial_reference_system.h
sql
gis
is_valid.h
Generated by
1.9.2