GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::FilterByBoxGeometryRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/filter_by_box_geometry.h>

Public Member Functions

 FilterByBoxGeometryRequest ()
 Constructs a FilterByBoxGeometryRequest object with default parameter values. More...
 
 FilterByBoxGeometryRequest (const std::string &tableName_, const std::string &viewName_, const std::string &columnName_, const double minX_, const double maxX_, const double minY_, const double maxY_, const std::map< std::string, std::string > &options_)
 Constructs a FilterByBoxGeometryRequest object with the specified parameters. More...
 

Public Attributes

std::string tableName
 
std::string viewName
 
std::string columnName
 
double minX
 
double maxX
 
double minY
 
double maxY
 
std::map< std::string,
std::string > 
options
 

Detailed Description

A set of input parameters for const.

Calculates which geospatial geometry objects from a table intersect a rectangular box. 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 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 24 of file filter_by_box_geometry.h.

Constructor & Destructor Documentation

gpudb::FilterByBoxGeometryRequest::FilterByBoxGeometryRequest ( )
inline

Constructs a FilterByBoxGeometryRequest object with default parameter values.

Definition at line 31 of file filter_by_box_geometry.h.

gpudb::FilterByBoxGeometryRequest::FilterByBoxGeometryRequest ( const std::string &  tableName_,
const std::string &  viewName_,
const std::string &  columnName_,
const double  minX_,
const double  maxX_,
const double  minY_,
const double  maxY_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a FilterByBoxGeometryRequest object with the specified parameters.

Parameters
[in]tableName_Name of the table on which the bounding box operation will be performed. Must be an existing table.
[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]columnName_Name of the geospatial geometry column to be filtered.
[in]minX_Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to maxX.
[in]maxX_Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to minX.
[in]minY_Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to maxY.
[in]maxY_Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to minY.
[in]options_Optional parameters.
  • gpudb::filter_by_box_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 80 of file filter_by_box_geometry.h.

Member Data Documentation

std::string gpudb::FilterByBoxGeometryRequest::columnName

Definition at line 94 of file filter_by_box_geometry.h.

double gpudb::FilterByBoxGeometryRequest::maxX

Definition at line 96 of file filter_by_box_geometry.h.

double gpudb::FilterByBoxGeometryRequest::maxY

Definition at line 98 of file filter_by_box_geometry.h.

double gpudb::FilterByBoxGeometryRequest::minX

Definition at line 95 of file filter_by_box_geometry.h.

double gpudb::FilterByBoxGeometryRequest::minY

Definition at line 97 of file filter_by_box_geometry.h.

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

Definition at line 99 of file filter_by_box_geometry.h.

std::string gpudb::FilterByBoxGeometryRequest::tableName

Definition at line 92 of file filter_by_box_geometry.h.

std::string gpudb::FilterByBoxGeometryRequest::viewName

Definition at line 93 of file filter_by_box_geometry.h.


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