GPUdb C++ API
Version 7.0.19.0
|
A set of input parameters for 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 |
A set of input parameters for 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 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 (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.
Definition at line 28 of file filter_by_radius.h.
|
inline |
Constructs a FilterByRadiusRequest object with default parameter values.
Definition at line 35 of file filter_by_radius.h.
|
inline |
Constructs a FilterByRadiusRequest object with the specified parameters.
[in] | tableName_ | Name of the table on which the filter by radius operation will be performed. Must be an existing table. |
[in] | viewName_ | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. |
[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.
|
Definition at line 88 of file filter_by_radius.h.
std::map<std::string, std::string> gpudb::FilterByRadiusRequest::options |
Definition at line 107 of file filter_by_radius.h.
double gpudb::FilterByRadiusRequest::radius |
Definition at line 106 of file filter_by_radius.h.
std::string gpudb::FilterByRadiusRequest::tableName |
Definition at line 100 of file filter_by_radius.h.
std::string gpudb::FilterByRadiusRequest::viewName |
Definition at line 101 of file filter_by_radius.h.
double gpudb::FilterByRadiusRequest::xCenter |
Definition at line 103 of file filter_by_radius.h.
std::string gpudb::FilterByRadiusRequest::xColumnName |
Definition at line 102 of file filter_by_radius.h.
double gpudb::FilterByRadiusRequest::yCenter |
Definition at line 105 of file filter_by_radius.h.
std::string gpudb::FilterByRadiusRequest::yColumnName |
Definition at line 104 of file filter_by_radius.h.