gpudb::FilterByBoxRequest Struct Reference

A set of input parameters for filterByBox(const FilterByBoxRequest&) const. More...

#include <gpudb/protocol/filter_by_box.h>

Public Member Functions
	FilterByBoxRequest ()
	Constructs a FilterByBoxRequest object with default parameter values. More...
	FilterByBoxRequest (const std::string &tableName, const std::string &viewName, const std::string &xColumnName, const double minX, const double maxX, const std::string &yColumnName, const double minY, const double maxY, const std::map< std::string, std::string > &options)
	Constructs a FilterByBoxRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
std::string	viewName
std::string	xColumnName
double	minX
double	maxX
std::string	yColumnName
double	minY
double	maxY
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for filterByBox(const FilterByBoxRequest&) const.

Calculates how many objects within the given table lie in a rectangular box. The operation is synchronous meaning that GPUdb will not return the request until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.

Definition at line 23 of file filter_by_box.h.

Constructor & Destructor Documentation

gpudb::FilterByBoxRequest::FilterByBoxRequest ( )

inline

Constructs a FilterByBoxRequest object with default parameter values.

Definition at line 30 of file filter_by_box.h.

gpudb::FilterByBoxRequest::FilterByBoxRequest ( const std::string &  tableName, const std::string &  viewName, const std::string &  xColumnName, const double  minX, const double  maxX, const std::string &  yColumnName, const double  minY, const double  maxY, const std::map< std::string, std::string > &  options  )

inline

Constructs a FilterByBoxRequest object with the specified parameters.

Parameters

[in]	tableName	Name of the table on which the bounding box operation will be performed. Must be a valid table in GPUdb.
[in]	viewName	Optional name of the result view that will be created containing the results of the query. Must not be an already existing collection, table or view in GPUdb. Default value is an empty string.
[in]	xColumnName	Name of the column on which to perform the bounding box query. If the table's data type is not a shape type, must be a valid numeric column.
[in]	minX	Lower bound for the column chosen by xColumnName. Must be less than or equal to maxX.
[in]	maxX	Upper bound for xColumnName. Must be greater than or equal to minX.
[in]	yColumnName	Name of a column on which to perform the bounding box query. If the table's data type is not a shape type, must be a valid numeric column.
[in]	minY	Lower bound for yColumnName. Must be less than or equal to maxY.
[in]	maxY	Upper bound for yColumnName. Must be greater than or equal to minY.
[in]	options	Optional parameters. Default value is an empty std::map.

Definition at line 76 of file filter_by_box.h.

Member Data Documentation

double gpudb::FilterByBoxRequest::maxX

Definition at line 93 of file filter_by_box.h.

double gpudb::FilterByBoxRequest::maxY

Definition at line 96 of file filter_by_box.h.

double gpudb::FilterByBoxRequest::minX

Definition at line 92 of file filter_by_box.h.

double gpudb::FilterByBoxRequest::minY

Definition at line 95 of file filter_by_box.h.

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

Definition at line 97 of file filter_by_box.h.

std::string gpudb::FilterByBoxRequest::tableName

Definition at line 89 of file filter_by_box.h.

std::string gpudb::FilterByBoxRequest::viewName

Definition at line 90 of file filter_by_box.h.

std::string gpudb::FilterByBoxRequest::xColumnName

Definition at line 91 of file filter_by_box.h.

std::string gpudb::FilterByBoxRequest::yColumnName

Definition at line 94 of file filter_by_box.h.

---

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

• gpudb/protocol/filter_by_box.h