gpudb::FilterBySeriesRequest Struct Reference

A set of input parameters for filterBySeries(const FilterBySeriesRequest&) const. More...

#include <gpudb/protocol/filter_by_series.h>

Public Member Functions
	FilterBySeriesRequest ()
	Constructs a FilterBySeriesRequest object with default parameter values. More...
	FilterBySeriesRequest (const std::string &tableName, const std::string &viewName, const std::string &trackId, const std::vector< std::string > &targetTrackIds, const std::map< std::string, std::string > &options)
	Constructs a FilterBySeriesRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
std::string	viewName
std::string	trackId
std::vector< std::string >	targetTrackIds
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for filterBySeries(const FilterBySeriesRequest&) const.

Filters objects matching all points of the given track (works only on track type data). It allows users to specify a particular track to find all other points in the table that fall within specified ranges-spatial and temporal-of all points of the given track. Additionally, the user can specify another track to see if the two intersect (or go close to each other within the specified ranges). The user also has the flexibility of using different metrics for the spatial distance calculation: Euclidean (flat geometry) or Great Circle (spherical geometry to approximate the Earth's surface distances). The filtered points are stored in a newly created result set. The return value of the function is the number of points in the resultant set (view).

This operation is synchronous meaning that GPUdb will not return a response until all the objects are fully available.

Definition at line 31 of file filter_by_series.h.

Constructor & Destructor Documentation

gpudb::FilterBySeriesRequest::FilterBySeriesRequest ( )

inline

Constructs a FilterBySeriesRequest object with default parameter values.

Definition at line 38 of file filter_by_series.h.

gpudb::FilterBySeriesRequest::FilterBySeriesRequest ( const std::string &  tableName, const std::string &  viewName, const std::string &  trackId, const std::vector< std::string > &  targetTrackIds, const std::map< std::string, std::string > &  options  )

inline

Constructs a FilterBySeriesRequest object with the specified parameters.

Parameters

[in]	tableName	Name of the table on which the filter by track operation will be performed. Must be a currently existing table with track semantic type.
[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]	trackId	The ID of the track which will act as the filtering points. Must be an existing track within the given table.
[in]	targetTrackIds	Up to one track ID to intersect with the "filter" track. If any provided, it must be an valid track ID within the given set.
[in]	options	Optional parameters. spatial_radius: A positive number passed as a string representing the radius of the search area centered around each track point's geospatial coordinates. The value is interpreted in meters. Required parameter. time_radius: A positive number passed as a string representing the maximum allowable time difference between the timestamps of a filtered object and the given track's points. The value is interpreted in seconds. Required parameter. spatial_distance_metric: A string representing the coordinate system to use for the spatial search criteria. Acceptable values are 'euclidean' and 'great_circle'. Optional parameter; default is 'euclidean'. Values: 'euclidean', 'great_circle'. Default value is an empty std::map.

Definition at line 89 of file filter_by_series.h.

Member Data Documentation

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

Definition at line 102 of file filter_by_series.h.

std::string gpudb::FilterBySeriesRequest::tableName

Definition at line 98 of file filter_by_series.h.

std::vector<std::string> gpudb::FilterBySeriesRequest::targetTrackIds

Definition at line 101 of file filter_by_series.h.

std::string gpudb::FilterBySeriesRequest::trackId

Definition at line 100 of file filter_by_series.h.

std::string gpudb::FilterBySeriesRequest::viewName

Definition at line 99 of file filter_by_series.h.

---

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

• gpudb/protocol/filter_by_series.h