MySQL  8.0.28
Source Code Documentation
transform.h
Go to the documentation of this file.
1 #ifndef SQL_GIS_TRANSFORM_H_INCLUDED
2 #define SQL_GIS_TRANSFORM_H_INCLUDED
3 
4 // Copyright (c) 2018, 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 of gis::transform, a function that converts
29 /// geometries from one spatial reference system to another.
30 
31 #include <memory> // std::unique_ptr
32 
33 #include "sql/dd/types/spatial_reference_system.h" // dd::Spatial_reference_system
34 #include "sql/gis/geometries.h"
35 
36 namespace gis {
37 
38 /// Transforms a geometry from one SRS to another.
39 ///
40 /// @param[in] source_srs The SRS of the input geometry.
41 /// @param[in] in The geometry to transform.
42 /// @param[in] target_srs The SRS of the output geometry.
43 /// @param[in] func_name Function name used in error reporting.
44 /// @param[out] out The output geometry.
45 ///
46 /// @retval false Success.
47 /// @retval true An error has occurred. The error has been reported with
48 /// my_error().
49 bool transform(const dd::Spatial_reference_system *source_srs,
50  const Geometry &in,
51  const dd::Spatial_reference_system *target_srs,
52  const char *func_name, std::unique_ptr<Geometry> *out) noexcept;
53 
54 } // namespace gis
55 
56 #endif // SQL_GIS_TRANSFORM_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 transform(const dd::Spatial_reference_system *source_srs, const Geometry &in, const dd::Spatial_reference_system *target_srs, const char *func_name, std::unique_ptr< Geometry > *out) noexcept
Transforms a geometry from one SRS to another.
Definition: transform.cc:228