A set of input parameters for filterByRadiusGeometry(const FilterByRadiusGeometryRequest&) const. More...

#include <gpudb/protocol/filter_by_radius_geometry.h>

Public Member Functions
	FilterByRadiusGeometryRequest ()
	Constructs a FilterByRadiusGeometryRequest object with default parameter values. More...

	FilterByRadiusGeometryRequest (const std::string &tableName_, const std::string &viewName_, const std::string &columnName_, const double xCenter_, const double yCenter_, const double radius_, const std::map< std::string, std::string > &options_)
	Constructs a FilterByRadiusGeometryRequest object with the specified parameters. More...

Public Attributes
std::string	tableName

std::string	viewName

std::string	columnName

double	xCenter

double	yCenter

double	radius

std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for filterByRadiusGeometry(const FilterByRadiusGeometryRequest&) const.

Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.

Definition at line 24 of file filter_by_radius_geometry.h.

Constructor & Destructor Documentation

◆ FilterByRadiusGeometryRequest() [1/2]

gpudb::FilterByRadiusGeometryRequest::FilterByRadiusGeometryRequest ( )

inline

Constructs a FilterByRadiusGeometryRequest object with default parameter values.

Definition at line 31 of file filter_by_radius_geometry.h.

◆ FilterByRadiusGeometryRequest() [2/2]

gpudb::FilterByRadiusGeometryRequest::FilterByRadiusGeometryRequest	(	const std::string &	tableName_,
		const std::string &	viewName_,
		const std::string &	columnName_,
		const double	xCenter_,
		const double	yCenter_,
		const double	radius_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a FilterByRadiusGeometryRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table on which the filter by radius operation will be performed. Must be an existing table.
[in]	viewName_	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view.
[in]	columnName_	Name of the geospatial geometry column to be filtered.
[in]	xCenter_	Value of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.
[in]	yCenter_	Value of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.
[in]	radius_	The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
[in]	options_	Optional parameters. gpudb::filter_by_radius_geometry_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.