A set of input parameters for filterByArea(const FilterByAreaRequest&) const. More...

#include <gpudb/protocol/filter_by_area.h>

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

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

Public Attributes
std::string	tableName

std::string	viewName

std::string	xColumnName

std::vector< double >	xVector

std::string	yColumnName

std::vector< double >	yVector

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

Detailed Description

A set of input parameters for filterByArea(const FilterByAreaRequest&) const.

Calculates which objects from a table are within 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.h.

Constructor & Destructor Documentation

◆ FilterByAreaRequest() [1/2]

gpudb::FilterByAreaRequest::FilterByAreaRequest ( )

inline

Constructs a FilterByAreaRequest object with default parameter values.

Definition at line 31 of file filter_by_area.h.

◆ FilterByAreaRequest() [2/2]

gpudb::FilterByAreaRequest::FilterByAreaRequest	(	const std::string &	tableName_,
		const std::string &	viewName_,
		const std::string &	xColumnName_,
		const std::vector< double > &	xVector_,
		const std::string &	yColumnName_,
		const std::vector< double > &	yVector_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a FilterByAreaRequest 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. Has the same naming restrictions as tables.
[in]	xColumnName_	Name of the column containing the x values to be filtered.
[in]	xVector_	List of x coordinates of the vertices of the polygon representing the area to be filtered.
[in]	yColumnName_	Name of the column containing the y values 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_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 78 of file filter_by_area.h.

Member Data Documentation

◆ options

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

Definition at line 95 of file filter_by_area.h.

◆ tableName

std::string gpudb::FilterByAreaRequest::tableName

Definition at line 89 of file filter_by_area.h.

◆ viewName

std::string gpudb::FilterByAreaRequest::viewName

Definition at line 90 of file filter_by_area.h.

◆ xColumnName

std::string gpudb::FilterByAreaRequest::xColumnName

Definition at line 91 of file filter_by_area.h.

◆ xVector

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

Definition at line 92 of file filter_by_area.h.

◆ yColumnName

std::string gpudb::FilterByAreaRequest::yColumnName

Definition at line 93 of file filter_by_area.h.

◆ yVector

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

Definition at line 94 of file filter_by_area.h.

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

gpudb/protocol/filter_by_area.h

Public Member Functions

Public Attributes