MySQL 9.1.0
Source Code Documentation
area.h
Go to the documentation of this file.
1/* Copyright (c) 2018, 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 obtaining area of geometry. */
27
28#ifndef SQL_GIS_AREA_H_INCLUDED
29#define SQL_GIS_AREA_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
34namespace gis {
35
36/* Calculate the area of a geometry.
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 Input geometry.
43 @param[in] func_name Function name used in error reporting.
44 @param[out] result Result. Invalid if `result_null`.
45 @param[out] result_null Whether result 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
51bool area(const dd::Spatial_reference_system *srs, const Geometry *g,
52 const char *func_name, double *result, bool *result_null) noexcept;
53
54} // namespace gis
55
56#endif // SQL_GIS_AREA_H_INCLUDED
Definition: spatial.h:213
Definition: spatial_reference_system.h:53
This file declares the geometry class hierarchy used by the server as the internal representation of ...
Definition: area.cc:47
bool area(const dd::Spatial_reference_system *srs, const Geometry *g, const char *func_name, double *result, bool *result_null) noexcept
Definition: area.cc:79
Definition: result.h:30