/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */ /* * Copyright 2023-Present Couchbase, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #pragma once #include #include #include #include #include namespace couchbase { /** * A search query which allows to match inside a geo polygon. * * If a target data-location falls within the box, its document is returned. * * @snippet test_unit_search.cxx search-geo-polygon * * @see https://docs.couchbase.com/server/current/fts/fts-supported-queries-geo-bounded-polygon.html server documentation * * @since 1.0.0 * @committed */ class geo_polygon_query : public search_query { public: /** * Create a new geo polygon query. * * @param points the points specifying corners of geo polygon. * * @since 1.0.0 * @committed */ explicit geo_polygon_query(std::vector points) : polygon_points_{ std::move(points) } { } /** * If a field is specified, only terms in that field will be matched. * * @param field_name name of the field to be matched * * @return this query for chaining purposes. * * @since 1.0.0 * @committed */ auto field(std::string field_name) -> geo_polygon_query& { field_ = std::move(field_name); return *this; } /** * @return encoded representation of the query. * * @since 1.0.0 * @internal */ [[nodiscard]] auto encode() const -> encoded_search_query override; private: std::vector polygon_points_; std::optional field_{}; }; } // namespace couchbase