GPUdb C++ API  Version 5.2.0.0
gpudb::FilterByGeometryRequest Struct Reference

A set of input parameters for filterByGeometry(const FilterByGeometryRequest&) const. More...

#include <gpudb/protocol/filter_by_geometry.h>

Public Member Functions

 FilterByGeometryRequest ()
 Constructs a FilterByGeometryRequest object with default parameter values. More...
 
 FilterByGeometryRequest (const std::string &tableName, const std::string &viewName, const std::string &columnName, const std::string &inputWkt, const std::string &operation, const std::map< std::string, std::string > &options)
 Constructs a FilterByGeometryRequest object with the specified parameters. More...
 

Public Attributes

std::string tableName
 
std::string viewName
 
std::string columnName
 
std::string inputWkt
 
std::string operation
 
std::map< std::string, std::string > options
 

Detailed Description

A set of input parameters for filterByGeometry(const FilterByGeometryRequest&) const.

Applies a geometry filter against a spatial column named WKT in a given table, collection or view. The filtering geometry is provided by inputWkt.

Definition at line 20 of file filter_by_geometry.h.

Constructor & Destructor Documentation

gpudb::FilterByGeometryRequest::FilterByGeometryRequest ( )
inline

Constructs a FilterByGeometryRequest object with default parameter values.

Definition at line 27 of file filter_by_geometry.h.

gpudb::FilterByGeometryRequest::FilterByGeometryRequest ( const std::string &  tableName,
const std::string &  viewName,
const std::string &  columnName,
const std::string &  inputWkt,
const std::string &  operation,
const std::map< std::string, std::string > &  options 
)
inline

Constructs a FilterByGeometryRequest object with the specified parameters.

Parameters
[in]tableNameName of the table on which the filter by geometry will be performed. Must be an existing table, collection or view containing a column named WKT.
[in]viewNameIf provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
[in]columnNameName of the column to be used in the filter. Must be 'WKT'
[in]inputWktA geometry in WKT format that will be used to filter the objects in tableName. Default value is an empty string.
[in]operationThe geometric filtering operation to perform Values: 'contains', 'crosses', 'disjoint', 'equals', 'intersects', 'overlaps', 'touches', 'within'.
[in]optionsOptional parameters. Default value is an empty std::map.

Definition at line 62 of file filter_by_geometry.h.

Member Data Documentation

std::string gpudb::FilterByGeometryRequest::columnName

Definition at line 74 of file filter_by_geometry.h.

std::string gpudb::FilterByGeometryRequest::inputWkt

Definition at line 75 of file filter_by_geometry.h.

std::string gpudb::FilterByGeometryRequest::operation

Definition at line 76 of file filter_by_geometry.h.

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

Definition at line 77 of file filter_by_geometry.h.

std::string gpudb::FilterByGeometryRequest::tableName

Definition at line 72 of file filter_by_geometry.h.

std::string gpudb::FilterByGeometryRequest::viewName

Definition at line 73 of file filter_by_geometry.h.


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