A set of parameters for Kinetica.filterByGeometry(string,string,string,string,string,IDictionary<string, string>). More...
Inheritance diagram for kinetica.FilterByGeometryRequest:
Collaboration diagram for kinetica.FilterByGeometryRequest:
Classes | |
| struct | Operation |
The geometric filtering operation to perform Supported values:
| |
Public Member Functions | |
| FilterByGeometryRequest () | |
| Constructs a FilterByGeometryRequest object with default parameters. More... | |
| FilterByGeometryRequest (string table_name, string view_name, string column_name, string input_wkt, string operation, IDictionary< string, string > options=null) | |
| Constructs a FilterByGeometryRequest 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 geometry 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 | column_name = "" [get, set] |
| Name of the column to be used in the filter. More... | |
| string | input_wkt [get, set] |
| A geometry in WKT format that will be used to filter the objects in . More... | |
| string | operation = "" [get, set] |
The geometric filtering operation to perform Supported values:
| |
| IDictionary< string, string > | options [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.filterByGeometry(string,string,string,string,string,IDictionary<string, string>).
Applies a geometry filter against a geospatial geometry column in a given table, collection or view. The filtering geometry is provided by input_wkt.
Definition at line 21 of file FilterByGeometry.cs.
Constructor & Destructor Documentation
◆ FilterByGeometryRequest() [1/2]
|
inline |
Constructs a FilterByGeometryRequest object with default parameters.
Definition at line 197 of file FilterByGeometry.cs.
◆ FilterByGeometryRequest() [2/2]
|
inline |
Constructs a FilterByGeometryRequest object with the specified parameters.
- Parameters
-
table_name Name of the table on which the filter by geometry will be performed. Must be an existing table, collection or view containing a geospatial geometry column. view_name If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. column_name Name of the column to be used in the filter. Must be a geospatial geometry column. input_wkt A geometry in WKT format that will be used to filter the objects in . operation The geometric filtering operation to perform Supported values: - CONTAINS: Matches records that contain the given WKT in , i.e. the given WKT is within the bounds of a record's geometry.
- CROSSES: Matches records that cross the given WKT.
- DISJOINT: Matches records that are disjoint from the given WKT.
- EQUALS: Matches records that are the same as the given WKT.
- INTERSECTS: Matches records that intersect the given WKT.
- OVERLAPS: Matches records that overlap the given WKT.
- TOUCHES: Matches records that touch the given WKT.
- WITHIN: Matches records that are within the given WKT.
options Optional parameters.
Definition at line 271 of file FilterByGeometry.cs.
Property Documentation
◆ column_name
|
getset |
Name of the column to be used in the filter.
Must be a geospatial geometry column.
Definition at line 128 of file FilterByGeometry.cs.
◆ input_wkt
|
getset |
A geometry in WKT format that will be used to filter the objects in .
Definition at line 133 of file FilterByGeometry.cs.
◆ operation
|
getset |
The geometric filtering operation to perform Supported values:
- CONTAINS: Matches records that contain the given WKT in , i.e.
the given WKT is within the bounds of a record's geometry. CROSSES: Matches records that cross the given WKT. DISJOINT: Matches records that are disjoint from the given WKT. EQUALS: Matches records that are the same as the given WKT. INTERSECTS: Matches records that intersect the given WKT. OVERLAPS: Matches records that overlap the given WKT. TOUCHES: Matches records that touch the given WKT. WITHIN: Matches records that are within the given WKT.
Definition at line 189 of file FilterByGeometry.cs.
◆ options
|
getset |
Optional parameters.
Definition at line 192 of file FilterByGeometry.cs.
◆ table_name
|
getset |
Name of the table on which the filter by geometry will be performed.
Must be an existing table, collection or view containing a geospatial geometry column.
Definition at line 118 of file FilterByGeometry.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.
Definition at line 124 of file FilterByGeometry.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/FilterByGeometry.cs
