Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.FilterByRadiusGeometryRequest Class Reference

A set of parameters for Kinetica.filterByRadiusGeometry(string,string,string,double,double,double,IDictionary{string, string}). More...

+ Inheritance diagram for kinetica.FilterByRadiusGeometryRequest:
+ Collaboration diagram for kinetica.FilterByRadiusGeometryRequest:

Classes

struct  Options
 Optional parameters. More...
 

Public Member Functions

 FilterByRadiusGeometryRequest ()
 Constructs a FilterByRadiusGeometryRequest object with default parameters. More...
 
 FilterByRadiusGeometryRequest (string table_name, string view_name, string column_name, double x_center, double y_center, double radius, IDictionary< string, string > options=null)
 Constructs a FilterByRadiusGeometryRequest 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 radius operation will be performed, in [schema_name. More...
 
string view_name [get, set]
 If provided, then this will be the name of the view containing the results, in [schema_name. More...
 
string column_name = "" [get, set]
 Name of the geospatial geometry column to be filtered. More...
 
double x_center [get, set]
 Value of the longitude of the center. More...
 
double y_center [get, set]
 Value of the latitude of the center. More...
 
double radius [get, set]
 The radius of the circle within which the search will be performed. More...
 
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.filterByRadiusGeometry(string,string,string,double,double,double,IDictionary{string, string}).


Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. circular NAI). The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input circular NAI restriction specification is also created if a view_name is passed in as part of the request.

Definition at line 30 of file FilterByRadiusGeometry.cs.

Constructor & Destructor Documentation

kinetica.FilterByRadiusGeometryRequest.FilterByRadiusGeometryRequest ( )
inline

Constructs a FilterByRadiusGeometryRequest object with default parameters.

Definition at line 185 of file FilterByRadiusGeometry.cs.

kinetica.FilterByRadiusGeometryRequest.FilterByRadiusGeometryRequest ( string  table_name,
string  view_name,
string  column_name,
double  x_center,
double  y_center,
double  radius,
IDictionary< string, string >  options = null 
)
inline

Constructs a FilterByRadiusGeometryRequest object with the specified parameters.

Parameters
table_nameName of the table on which the filter by radius operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
view_nameIf provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
column_nameName of the geospatial geometry column to be filtered.
x_centerValue of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.
y_centerValue of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.
radiusThe radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
optionsOptional parameters.
  • CREATE_TEMP_TABLE: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the view as part of and use /create/schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.
The default value is an empty Dictionary.

Definition at line 255 of file FilterByRadiusGeometry.cs.

Property Documentation

string kinetica.FilterByRadiusGeometryRequest.column_name = ""
getset

Name of the geospatial geometry column to be filtered.

Definition at line 125 of file FilterByRadiusGeometry.cs.

IDictionary<string, string> kinetica.FilterByRadiusGeometryRequest.options
getset

Optional parameters.

  • CREATE_TEMP_TABLE: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values: The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the view as part of and use /create/schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created.

The default value is an empty Dictionary.

Definition at line 180 of file FilterByRadiusGeometry.cs.

double kinetica.FilterByRadiusGeometryRequest.radius
getset

The radius of the circle within which the search will be performed.

Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT.

Definition at line 141 of file FilterByRadiusGeometry.cs.

string kinetica.FilterByRadiusGeometryRequest.table_name
getset

Name of the table on which the filter by radius operation will be performed, in [schema_name.

]table_name format, using standard name resolution rules. Must be an existing table.

Definition at line 112 of file FilterByRadiusGeometry.cs.

string kinetica.FilterByRadiusGeometryRequest.view_name
getset

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

]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.

Definition at line 121 of file FilterByRadiusGeometry.cs.

double kinetica.FilterByRadiusGeometryRequest.x_center
getset

Value of the longitude of the center.

Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180.

Definition at line 130 of file FilterByRadiusGeometry.cs.

double kinetica.FilterByRadiusGeometryRequest.y_center
getset

Value of the latitude of the center.

Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90.

Definition at line 135 of file FilterByRadiusGeometry.cs.


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