Kinetica C# API
Version 7.1.10.0
|
A set of parameters for Kinetica.filterByRadius(string,string,string,double,string,double,double,IDictionary{string, string}). More...
Classes | |
struct | Options |
Optional parameters. More... | |
Public Member Functions | |
FilterByRadiusRequest () | |
Constructs a FilterByRadiusRequest object with default parameters. More... | |
FilterByRadiusRequest (string table_name, string view_name, string x_column_name, double x_center, string y_column_name, double y_center, double radius, IDictionary< string, string > options=null) | |
Constructs a FilterByRadiusRequest object with the specified parameters. More... | |
![]() | |
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 | x_column_name = "" [get, set] |
Name of the column to be used for the x-coordinate (the longitude) of the center. More... | |
double | x_center [get, set] |
Value of the longitude of the center. More... | |
string | y_column_name [get, set] |
Name of the column to be used for the y-coordinate-the latitude-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... | |
![]() | |
Schema | Schema [get] |
Avro Schema for this class More... | |
Additional Inherited Members | |
![]() | |
static RecordSchema | SchemaFromType (System.Type t, KineticaType ktype=null) |
Create an Avro Schema from a System.Type and a KineticaType. More... | |
A set of parameters for Kinetica.filterByRadius(string,string,string,double,string,double,double,IDictionary{string, string}).
Calculates which objects from a table lie within 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.
For track data, all track points that lie within the circle plus one point on either side of the circle (if the track goes beyond the circle) will be included in the result.
Definition at line 35 of file FilterByRadius.cs.
|
inline |
Constructs a FilterByRadiusRequest object with default parameters.
Definition at line 194 of file FilterByRadius.cs.
|
inline |
Constructs a FilterByRadiusRequest object with the specified parameters.
table_name | 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. |
view_name | 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 ''. |
x_column_name | Name of the column to be used for the x-coordinate (the longitude) of the center. |
x_center | 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. |
y_column_name | Name of the column to be used for the y-coordinate-the latitude-of the center. |
y_center | 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. |
radius | 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. |
options | Optional parameters.
|
Definition at line 266 of file FilterByRadius.cs.
|
getset |
Optional parameters.
The default value is an empty Dictionary.
Definition at line 189 of file FilterByRadius.cs.
|
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 150 of file FilterByRadius.cs.
|
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 117 of file FilterByRadius.cs.
|
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 126 of file FilterByRadius.cs.
|
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 135 of file FilterByRadius.cs.
|
getset |
Name of the column to be used for the x-coordinate (the longitude) of the center.
Definition at line 130 of file FilterByRadius.cs.
|
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 144 of file FilterByRadius.cs.
|
getset |
Name of the column to be used for the y-coordinate-the latitude-of the center.
Definition at line 139 of file FilterByRadius.cs.