A set of input parameters for filterByAreaGeometry(const FilterByAreaGeometryRequest&) const. More...

#include <gpudb/protocol/filter_by_area_geometry.h>

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

	FilterByAreaGeometryRequest (const std::string &tableName_, const std::string &viewName_, const std::string &columnName_, const std::vector< double > &xVector_, const std::vector< double > &yVector_, const std::map< std::string, std::string > &options_)
	Constructs a FilterByAreaGeometryRequest object with the specified parameters. More...

Public Attributes
std::string	tableName

std::string	viewName

std::string	columnName

std::vector< double >	xVector

std::vector< double >	yVector

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

Detailed Description

A set of input parameters for filterByAreaGeometry(const FilterByAreaGeometryRequest&) const.

Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name viewName passed in as part of the input.

Definition at line 24 of file filter_by_area_geometry.h.

Constructor & Destructor Documentation

◆ FilterByAreaGeometryRequest() [1/2]

gpudb::FilterByAreaGeometryRequest::FilterByAreaGeometryRequest ( )

inline

Constructs a FilterByAreaGeometryRequest object with default parameter values.

Definition at line 31 of file filter_by_area_geometry.h.

◆ FilterByAreaGeometryRequest() [2/2]

gpudb::FilterByAreaGeometryRequest::FilterByAreaGeometryRequest	(	const std::string &	tableName_,
		const std::string &	viewName_,
		const std::string &	columnName_,
		const std::vector< double > &	xVector_,
		const std::vector< double > &	yVector_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a FilterByAreaGeometryRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table to filter. This may be the name of a collection, a table or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by viewName.
[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]	xVector_	List of x coordinates of the vertices of the polygon representing the area to be filtered.
[in]	yVector_	List of y coordinates of the vertices of the polygon representing the area to be filtered.
[in]	options_	Optional parameters. gpudb::filter_by_area_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.

Definition at line 73 of file filter_by_area_geometry.h.

Member Data Documentation

◆ columnName

std::string gpudb::FilterByAreaGeometryRequest::columnName

Definition at line 85 of file filter_by_area_geometry.h.

◆ options

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

Definition at line 88 of file filter_by_area_geometry.h.

◆ tableName

std::string gpudb::FilterByAreaGeometryRequest::tableName

Definition at line 83 of file filter_by_area_geometry.h.

◆ viewName

std::string gpudb::FilterByAreaGeometryRequest::viewName

Definition at line 84 of file filter_by_area_geometry.h.

◆ xVector

std::vector<double> gpudb::FilterByAreaGeometryRequest::xVector

Definition at line 86 of file filter_by_area_geometry.h.

◆ yVector

std::vector<double> gpudb::FilterByAreaGeometryRequest::yVector

Definition at line 87 of file filter_by_area_geometry.h.

The documentation for this struct was generated from the following file:

gpudb/protocol/filter_by_area_geometry.h

Public Member Functions

Public Attributes