MySQL 8.0.29
Source Code Documentation
length.h
Go to the documentation of this file.
1#ifndef GIS__LENGTH_H_INCLUDED
2#define GIS__LENGTH_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 the length of linestrings and
29/// multilinestrings.
30
31#include "sql/dd/types/spatial_reference_system.h" // dd::Spatial_reference_system
32#include "sql/gis/geometries.h"
33
34namespace gis {
35/// Computes the length of linestrings and multilinestrings.
36///
37/// @param[in] srs The spatial reference system.
38/// @param[in] g1 linestring or multilinestring.
39/// @param[out] distance The length of g1 in the SRS linear unit.
40/// @param[out] null True if the return value is NULL.
41///
42/// @retval false Success.
43/// @retval true An error has occurred. The error has been reported with
44/// my_error().
45bool length(const dd::Spatial_reference_system *srs, const Geometry *g1,
46 double *distance, bool *null) noexcept;
47
48} // namespace gis
49
50#endif // GIS__LENGTH_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 length(const dd::Spatial_reference_system *srs, const Geometry *g1, double *length, bool *null) noexcept
Computes the length of linestrings and multilinestrings.
Definition: length.cc:75
bool distance(const dd::Spatial_reference_system *srs, const Geometry *g1, const Geometry *g2, double *distance, bool *is_null) noexcept
Computes the distance between two geometries.
Definition: distance.cc:39