A set of parameters for Kinetica.filterByArea(string,string,string,IList<double>,string,IList<double>,IDictionary<string, string>). More...
Inheritance diagram for kinetica.FilterByAreaRequest:
Collaboration diagram for kinetica.FilterByAreaRequest:
Classes | |
| struct | Options |
| Optional parameters. More... | |
Public Member Functions | |
| FilterByAreaRequest () | |
| Constructs a FilterByAreaRequest object with default parameters. More... | |
| FilterByAreaRequest (string table_name, string view_name, string x_column_name, IList< double > x_vector, string y_column_name, IList< double > y_vector, IDictionary< string, string > options=null) | |
| Constructs a FilterByAreaRequest 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 to filter. More... | |
| string | view_name [get, set] |
| If provided, then this will be the name of the view containing the results. More... | |
| string | x_column_name = "" [get, set] |
| Name of the column containing the x values to be filtered. More... | |
| IList< double > | x_vector [get, set] |
| List of x coordinates of the vertices of the polygon representing the area to be filtered. More... | |
| string | y_column_name = new List<double>() [get, set] |
| Name of the column containing the y values to be filtered. More... | |
| IList< double > | y_vector [get, set] |
| List of y coordinates of the vertices of the polygon representing the area to be filtered. More... | |
| IDictionary< string, string > | options = new List<double>() [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 Kinetica.filterByArea(string,string,string,IList<double>,string,IList<double>,IDictionary<string, string>).
Calculates which objects from a table are within a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name view_name passed in as part of the input.
Definition at line 25 of file FilterByArea.cs.
Constructor & Destructor Documentation
◆ FilterByAreaRequest() [1/2]
|
inline |
Constructs a FilterByAreaRequest object with default parameters.
Definition at line 100 of file FilterByArea.cs.
◆ FilterByAreaRequest() [2/2]
|
inline |
Constructs a FilterByAreaRequest object with the specified parameters.
- Parameters
-
table_name Name of the table to filter. This may be the name of a collection, a table or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by . view_name If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. x_column_name Name of the column containing the x values to be filtered. x_vector List of x coordinates of the vertices of the polygon representing the area to be filtered. y_column_name Name of the column containing the y values to be filtered. y_vector List of y coordinates of the vertices of the polygon representing the area to be filtered. options Optional parameters. - COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
Definition at line 136 of file FilterByArea.cs.
Property Documentation
◆ options
|
getset |
Optional parameters.
- COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
The default value is an empty Dictionary.
Definition at line 95 of file FilterByArea.cs.
◆ table_name
|
getset |
Name of the table to filter.
This may be the name of a collection, a table or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by .
Definition at line 59 of file FilterByArea.cs.
◆ view_name
|
getset |
If provided, then this will be the name of the view containing the results.
Has the same naming restrictions as tables. The default value is ''.
Definition at line 65 of file FilterByArea.cs.
◆ x_column_name
|
getset |
Name of the column containing the x values to be filtered.
Definition at line 69 of file FilterByArea.cs.
◆ x_vector
|
getset |
List of x coordinates of the vertices of the polygon representing the area to be filtered.
Definition at line 73 of file FilterByArea.cs.
◆ y_column_name
|
getset |
Name of the column containing the y values to be filtered.
Definition at line 77 of file FilterByArea.cs.
◆ y_vector
|
getset |
List of y coordinates of the vertices of the polygon representing the area to be filtered.
Definition at line 81 of file FilterByArea.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/FilterByArea.cs
