A set of parameters for Kinetica.filterByAreaGeometry(string,string,string,IList<double>,IList<double>,IDictionary<string, string>). More...
Inheritance diagram for kinetica.FilterByAreaGeometryRequest:
Collaboration diagram for kinetica.FilterByAreaGeometryRequest:
Classes | |
| struct | Options |
| Optional parameters. More... | |
Public Member Functions | |
| FilterByAreaGeometryRequest () | |
| Constructs a FilterByAreaGeometryRequest object with default parameters. More... | |
| FilterByAreaGeometryRequest (string table_name, string view_name, string column_name, IList< double > x_vector, IList< double > y_vector, IDictionary< string, string > options=null) | |
| Constructs a FilterByAreaGeometryRequest 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 | column_name = "" [get, set] |
| Name of the geospatial geometry column 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... | |
| IList< double > | y_vector = new List<double>() [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.filterByAreaGeometry(string,string,string,IList<double>,IList<double>,IDictionary<string, string>).
Calculates which geospatial geometry objects from a table intersect 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 FilterByAreaGeometry.cs.
Constructor & Destructor Documentation
◆ FilterByAreaGeometryRequest() [1/2]
|
inline |
Constructs a FilterByAreaGeometryRequest object with default parameters.
Definition at line 95 of file FilterByAreaGeometry.cs.
◆ FilterByAreaGeometryRequest() [2/2]
|
inline |
Constructs a FilterByAreaGeometryRequest 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. Must not be an already existing collection, table or view. The default value is ''. column_name Name of the geospatial geometry column to be filtered. x_vector List of x coordinates of the vertices of the polygon representing the area 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 128 of file FilterByAreaGeometry.cs.
Property Documentation
◆ column_name
|
getset |
Name of the geospatial geometry column to be filtered.
Definition at line 68 of file FilterByAreaGeometry.cs.
◆ 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 90 of file FilterByAreaGeometry.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 FilterByAreaGeometry.cs.
◆ view_name
|
getset |
If provided, then this will be the name of the view containing the results.
Must not be an already existing collection, table or view. The default value is ''.
Definition at line 64 of file FilterByAreaGeometry.cs.
◆ x_vector
|
getset |
List of x coordinates of the vertices of the polygon representing the area to be filtered.
Definition at line 72 of file FilterByAreaGeometry.cs.
◆ y_vector
|
getset |
List of y coordinates of the vertices of the polygon representing the area to be filtered.
Definition at line 76 of file FilterByAreaGeometry.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/FilterByAreaGeometry.cs
