A set of parameters for /filter/byradius. More...

Inheritance diagram for kinetica.FilterByRadiusRequest:

Collaboration diagram for kinetica.FilterByRadiusRequest:

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...

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. 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 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...

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 /filter/byradius.

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 <member name="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. For shapes, e.g. polygons, all polygons that intersect the circle will be included (even if none of the points of the polygon fall within the circle).

Definition at line 29 of file FilterByRadius.cs.

Constructor & Destructor Documentation

kinetica.FilterByRadiusRequest.FilterByRadiusRequest ( )

inline

Constructs a FilterByRadiusRequest object with default parameters.

Definition at line 72 of file FilterByRadius.cs.

kinetica.FilterByRadiusRequest.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`
	)

inline

Constructs a FilterByRadiusRequest object with the specified parameters.

Parameters

table_name	Name of the table on which the filter by radius operation will be performed. Must be an existing table.
view_name	If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
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 101 of file FilterByRadius.cs.

Property Documentation

IDictionary<string, string> kinetica.FilterByRadiusRequest.options

getset

Optional parameters.

Definition at line 67 of file FilterByRadius.cs.

double kinetica.FilterByRadiusRequest.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 64 of file FilterByRadius.cs.

string kinetica.FilterByRadiusRequest.table_name

getset

Name of the table on which the filter by radius operation will be performed.

Must be an existing table.

Definition at line 34 of file FilterByRadius.cs.

string kinetica.FilterByRadiusRequest.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 40 of file FilterByRadius.cs.

double kinetica.FilterByRadiusRequest.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 49 of file FilterByRadius.cs.

string kinetica.FilterByRadiusRequest.x_column_name = ""

getset

Name of the column to be used for the x-coordinate (the longitude) of the center.

Definition at line 44 of file FilterByRadius.cs.

double kinetica.FilterByRadiusRequest.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 58 of file FilterByRadius.cs.

string kinetica.FilterByRadiusRequest.y_column_name

getset

Name of the column to be used for the y-coordinate-the latitude-of the center.

Definition at line 53 of file FilterByRadius.cs.

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

Kinetica/Protocol/FilterByRadius.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation