A set of input parameters for filterByRadius(const FilterByRadiusRequest&) const. More...

#include <gpudb/protocol/filter_by_radius.h>

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

	FilterByRadiusRequest (const std::string &tableName, const std::string &viewName, const std::string &xColumnName, const double xCenter, const std::string &yColumnName, const double yCenter, const double radius, const std::map< std::string, std::string > &options)
	Constructs a FilterByRadiusRequest object with the specified parameters. More...

Public Attributes
std::string	tableName

std::string	viewName

std::string	xColumnName

double	xCenter

std::string	yColumnName

double	yCenter

double	radius

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

Detailed Description

A set of input parameters for filterByRadius(const FilterByRadiusRequest&) const.

Calculates which objects from a table lie within a circle with the given radius and center point (i.e. circular NAI). The operation is synchronous meaning that GPUdb will not return a response until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a viewName is passed in as part of the request.

For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result. For shapes, e.g. polygons, all polygons that intersect the circle will be included (even if none of the points of the polygon fall within the circle).

Definition at line 30 of file filter_by_radius.h.

Constructor & Destructor Documentation

gpudb::FilterByRadiusRequest::FilterByRadiusRequest ( )

inline

Constructs a FilterByRadiusRequest object with default parameter values.

Definition at line 37 of file filter_by_radius.h.

gpudb::FilterByRadiusRequest::FilterByRadiusRequest	(	const std::string &	tableName,
		const std::string &	viewName,
		const std::string &	xColumnName,
		const double	xCenter,
		const std::string &	yColumnName,
		const double	yCenter,
		const double	radius,
		const std::map< std::string, std::string > &	options
	)

inline

Constructs a FilterByRadiusRequest object with the specified parameters.

Parameters

[in]	tableName	Name of the table on which the filter by radius operation will be performed. Must be an existing table in GPUdb.
[in]	viewName	If 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]	xColumnName	Name of the column to be used for the x-coordinate (the longitude) of the center.
[in]	xCenter	Value of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.
[in]	yColumnName	Name of the column to be used for the y-coordinate-the latitude-of the center.
[in]	yCenter	Value of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.
[in]	radius	The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
[in]	options	Optional parameters. Default value is an empty std::map.

Definition at line 79 of file filter_by_radius.h.

Member Data Documentation

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

Definition at line 98 of file filter_by_radius.h.

double gpudb::FilterByRadiusRequest::radius

Definition at line 97 of file filter_by_radius.h.

std::string gpudb::FilterByRadiusRequest::tableName

Definition at line 91 of file filter_by_radius.h.

std::string gpudb::FilterByRadiusRequest::viewName

Definition at line 92 of file filter_by_radius.h.

double gpudb::FilterByRadiusRequest::xCenter

Definition at line 94 of file filter_by_radius.h.

std::string gpudb::FilterByRadiusRequest::xColumnName

Definition at line 93 of file filter_by_radius.h.

double gpudb::FilterByRadiusRequest::yCenter

Definition at line 96 of file filter_by_radius.h.

std::string gpudb::FilterByRadiusRequest::yColumnName

Definition at line 95 of file filter_by_radius.h.

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

gpudb/protocol/filter_by_radius.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Data Documentation