GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::FilterBySeriesRequest Struct Reference

A set of input parameters for 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 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 a response will not be returned 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 a track present.
[in]viewName_If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
[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.

Definition at line 105 of file filter_by_series.h.

Member Data Documentation

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

Definition at line 118 of file filter_by_series.h.

std::string gpudb::FilterBySeriesRequest::tableName

Definition at line 114 of file filter_by_series.h.

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

Definition at line 117 of file filter_by_series.h.

std::string gpudb::FilterBySeriesRequest::trackId

Definition at line 116 of file filter_by_series.h.

std::string gpudb::FilterBySeriesRequest::viewName

Definition at line 115 of file filter_by_series.h.


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