kinetica.FilterBySeriesRequest Class Reference

A set of parameters for /filter/byseries. More...

Inheritance diagram for kinetica.FilterBySeriesRequest:

Collaboration diagram for kinetica.FilterBySeriesRequest:

Classes
struct	Options
	Optional parameters. More...

Public Member Functions
	FilterBySeriesRequest ()
	Constructs a FilterBySeriesRequest object with default parameters. More...
	FilterBySeriesRequest (string table_name, string view_name, string track_id, IList< string > target_track_ids, IDictionary< string, string > options=null)
	Constructs a FilterBySeriesRequest object with the specified parameters. More...
Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...
	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...
object	Get (int fieldPos)
	Retrieve a specific property from this object More...
void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	table_name [get, set]
	Name of the table on which the filter by track operation will be performed. More...
string	view_name [get, set]
	If provided, then this will be the name of the view containing the results. More...
string	track_id = "" [get, set]
	The ID of the track which will act as the filtering points. More...
IList< string >	target_track_ids [get, set]
	Up to one track ID to intersect with the "filter" track. More...
IDictionary< string, string >	options = new List<string>() [get, set]
	Optional parameters. More...
Properties inherited from kinetica.KineticaData
Schema	Schema [get]
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema	SchemaFromType (System.Type t, KineticaType ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for /filter/byseries.

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 FilterBySeries.cs.

Constructor & Destructor Documentation

kinetica.FilterBySeriesRequest.FilterBySeriesRequest ( )

inline

Constructs a FilterBySeriesRequest object with default parameters.

Definition at line 140 of file FilterBySeries.cs.

kinetica.FilterBySeriesRequest.FilterBySeriesRequest ( string  table_name, string  view_name, string  track_id, IList< string >  target_track_ids, IDictionary< string, string >  options = null  )

inline

Constructs a FilterBySeriesRequest object with the specified parameters.

Parameters

table_name	Name of the table on which the filter by track operation will be performed. Must be a currently existing table with track semantic type.
view_name	If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
track_id	The ID of the track which will act as the filtering points. Must be an existing track within the given table.
target_track_ids	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.
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.

Definition at line 185 of file FilterBySeries.cs.

Property Documentation

IDictionary<string, string> kinetica.FilterBySeriesRequest.options = new List<string>()

getset

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.

Definition at line 135 of file FilterBySeries.cs.

string kinetica.FilterBySeriesRequest.table_name

getset

Name of the table on which the filter by track operation will be performed.

Must be a currently existing table with track semantic type.

Definition at line 91 of file FilterBySeries.cs.

IList<string> kinetica.FilterBySeriesRequest.target_track_ids

getset

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.

Definition at line 107 of file FilterBySeries.cs.

string kinetica.FilterBySeriesRequest.track_id = ""

getset

The ID of the track which will act as the filtering points.

Must be an existing track within the given table.

Definition at line 102 of file FilterBySeries.cs.

string kinetica.FilterBySeriesRequest.view_name

getset

If provided, then this will be the name of the view containing the results.

Has the same naming restrictions as tables.

Definition at line 97 of file FilterBySeries.cs.

---

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

• Kinetica/Protocol/FilterBySeries.cs