MySQL
9.1.0
Source Code Documentation
is_simple.h
Go to the documentation of this file.
1
// Copyright (c) 2017, 2024, Oracle and/or its affiliates.
2
//
3
// This program is free software; you can redistribute it and/or modify
4
// it under the terms of the GNU General Public License, version 2.0,
5
// as published by the Free Software Foundation.
6
//
7
// This program is designed to work with certain software (including
8
// but not limited to OpenSSL) that is licensed under separate terms,
9
// as designated in a particular file or component or in included license
10
// documentation. The authors of MySQL hereby grant you an additional
11
// permission to link the program and your derivative works with the
12
// separately licensed software that they have either included with
13
// the program or referenced in the documentation.
14
//
15
// This program is distributed in the hope that it will be useful,
16
// but WITHOUT ANY WARRANTY; without even the implied warranty of
17
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18
// GNU General Public License, version 2.0, for more details.
19
//
20
// You should have received a copy of the GNU General Public License
21
// along with this program; if not, write to the Free Software
22
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
23
24
/// @file
25
///
26
/// Interface for determining if geometry is simple.
27
28
#ifndef SQL_GIS_IS_SIMPLE_H_INCLUDED
29
#define SQL_GIS_IS_SIMPLE_H_INCLUDED
30
31
#include "
sql/dd/types/spatial_reference_system.h
"
// dd::Spatial_reference_system
32
#include "
sql/gis/geometries.h
"
// gis::Geometry
33
34
namespace
gis
{
35
36
/// Test whether geometry is geometrically simple.
37
///
38
/// The coordinate system of the geometry must match the coordinate system of
39
/// the SRID. It is the caller's responsibility to guarantee this.
40
///
41
/// @param[in] srs The spatial reference system.
42
/// @param[in] g Geometry for testing.
43
/// @param[in] func_name Function name used in error reporting.
44
/// @param[out] result Whether `g` is simple. Invalid if `result_null`.
45
/// @param[out] result_null Whether return value is `NULL` instead of `result`.
46
///
47
/// @retval false Success.
48
/// @retval true An error has occurred. The error has been reported with
49
/// my_error().
50
bool
is_simple
(
const
dd::Spatial_reference_system
*srs,
const
Geometry
*g,
51
const
char
*func_name,
bool
*
result
,
bool
*result_null)
noexcept
;
52
53
}
// namespace gis
54
55
#endif
// include guard
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_simple
bool is_simple(const dd::Spatial_reference_system *srs, const Geometry *g, const char *func_name, bool *result, bool *result_null) noexcept
Test whether geometry is geometrically simple.
Definition:
is_simple.cc:147
spatial_reference_system.h
result
Definition:
result.h:30
sql
gis
is_simple.h
Generated by
1.9.2