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 geospatial geometry column 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

◆ FilterByGeometryRequest() [1/2]

gpudb::FilterByGeometryRequest::FilterByGeometryRequest ( )

inline

Constructs a FilterByGeometryRequest object with default parameter values.

Definition at line 27 of file filter_by_geometry.h.

◆ FilterByGeometryRequest() [2/2]

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]	tableName_	Name of the table on which the filter by geometry will be performed. Must be an existing table, collection or view containing a geospatial geometry column.
[in]	viewName_	If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
[in]	columnName_	Name of the column to be used in the filter. Must be a geospatial geometry column.
[in]	inputWkt_	A geometry in WKT format that will be used to filter the objects in tableName.
[in]	operation_	The geometric filtering operation to perform gpudb::filter_by_geometry_contains: Matches records that contain the given WKT in inputWkt, i.e. the given WKT is within the bounds of a record's geometry. gpudb::filter_by_geometry_crosses: Matches records that cross the given WKT. gpudb::filter_by_geometry_disjoint: Matches records that are disjoint from the given WKT. gpudb::filter_by_geometry_equals: Matches records that are the same as the given WKT. gpudb::filter_by_geometry_intersects: Matches records that intersect the given WKT. gpudb::filter_by_geometry_overlaps: Matches records that overlap the given WKT. gpudb::filter_by_geometry_touches: Matches records that touch the given WKT. gpudb::filter_by_geometry_within: Matches records that are within the given WKT.
[in]	options_	Optional parameters. gpudb::filter_by_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 95 of file filter_by_geometry.h.

Member Data Documentation

◆ columnName

std::string gpudb::FilterByGeometryRequest::columnName

Definition at line 107 of file filter_by_geometry.h.

◆ inputWkt

std::string gpudb::FilterByGeometryRequest::inputWkt

Definition at line 108 of file filter_by_geometry.h.

◆ operation

std::string gpudb::FilterByGeometryRequest::operation

Definition at line 109 of file filter_by_geometry.h.

◆ options

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

Definition at line 110 of file filter_by_geometry.h.

◆ tableName

std::string gpudb::FilterByGeometryRequest::tableName

Definition at line 105 of file filter_by_geometry.h.

◆ viewName

std::string gpudb::FilterByGeometryRequest::viewName

Definition at line 106 of file filter_by_geometry.h.

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

gpudb/protocol/filter_by_geometry.h

Public Member Functions

Public Attributes