kinetica.FilterByRadiusRequest

A set of parameters for Kinetica.filterByRadius. More…

Inheritance diagram for kinetica.FilterByRadiusRequest:

Collaboration diagram for kinetica.FilterByRadiusRequest:

Classes
struct	Options
	A set of string constants for the parameter FilterByRadiusRequest.options. More…

Public Member Functions
	FilterByRadiusRequest ()
	Constructs a FilterByRadiusRequest object with default parameters.

	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.

	FilterByRadiusRequest ()
	Constructs a FilterByRadiusRequest object with default parameters.

	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.

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type.

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type.

object	Get (int fieldPos)
	Retrieve a specific property from this object.

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object.

	KineticaData (KineticaType type)
	Constructor from Kinetica Type.

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type.

object	Get (int fieldPos)
	Retrieve a specific property from this object.

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object.

Properties
string	table_name `[get, set]`
	Name of the table on which the filter by radius operation will be performed, in [schema_name.

string	view_name = "" `[get, set]`
	If provided, then this will be the name of the view containing the results, in [schema_name.

string	x_column_name `[get, set]`
	Name of the column to be used for the x-coordinate (the longitude) of the center.

double	x_center `[get, set]`
	Value of the longitude of the center.

string	y_column_name `[get, set]`
	Name of the column to be used for the y-coordinate-the latitude-of the center.

double	y_center `[get, set]`
	Value of the latitude of the center.

double	radius `[get, set]`
	The radius of the circle within which the search will be performed.

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Optional parameters.

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class.

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.

static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType.

Detailed Description

A set of parameters for Kinetica.filterByRadius.

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 FilterByRadiusRequest.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 25 of file FilterByRadius.cs.

Constructor & Destructor Documentation

◆ FilterByRadiusRequest() [1/4]

kinetica.FilterByRadiusRequest.FilterByRadiusRequest ( )

inline

Constructs a FilterByRadiusRequest object with default parameters.

Definition at line 168 of file FilterByRadius.cs.

◆ FilterByRadiusRequest() [2/4]

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, 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. CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of view_name . 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: TRUE FALSE The default value is FALSE. COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the view as part of view_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema which is to contain the newly created view. If the schema is non-existent, it will be automatically created. The default value is an empty Dictionary.

Definition at line 244 of file FilterByRadius.cs.

◆ FilterByRadiusRequest() [3/4]

kinetica.FilterByRadiusRequest.FilterByRadiusRequest ( )

inline

Constructs a FilterByRadiusRequest object with default parameters.

Definition at line 168 of file FilterByRadius.cs.

◆ FilterByRadiusRequest() [4/4]

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, 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. CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of view_name . 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: TRUE FALSE The default value is FALSE. COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the view as part of view_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema which is to contain the newly created view. If the schema is non-existent, it will be automatically created. The default value is an empty Dictionary.

Definition at line 244 of file FilterByRadius.cs.

Property Documentation

◆ options

IDictionary< string, string > kinetica.FilterByRadiusRequest.options = new Dictionary<string, string>()

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 FilterByRadiusRequest.view_name. 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:
- TRUE
- FALSE
The default value is FALSE.
COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the view as part of FilterByRadiusRequest.view_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema which is to contain the newly created view. If the schema is non-existent, it will be automatically created.

The default value is an empty Dictionary.

Definition at line 164 of file FilterByRadius.cs.

◆ radius

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 117 of file FilterByRadius.cs.

◆ table_name

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

◆ view_name

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

◆ x_center

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 101 of file FilterByRadius.cs.

◆ x_column_name

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 96 of file FilterByRadius.cs.

◆ y_center

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 110 of file FilterByRadius.cs.

◆ y_column_name

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 105 of file FilterByRadius.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/FilterByRadius.cs
Kinetica/Protocol/FilterByRadius.cs

​ Classes

​ Public Member Functions

​ Properties

​ Additional Inherited Members

​Detailed Description

​Constructor & Destructor Documentation

​◆ FilterByRadiusRequest() [1/4]

​◆ FilterByRadiusRequest() [2/4]

​◆ FilterByRadiusRequest() [3/4]

​◆ FilterByRadiusRequest() [4/4]

​Property Documentation

​◆ options

​◆ radius

​◆ table_name

​◆ view_name

​◆ x_center

​◆ x_column_name

​◆ y_center

​◆ y_column_name

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FilterByRadiusRequest() [1/4]

◆ FilterByRadiusRequest() [2/4]

◆ FilterByRadiusRequest() [3/4]

◆ FilterByRadiusRequest() [4/4]

Property Documentation

◆ options

◆ radius

◆ table_name

◆ view_name

◆ x_center

◆ x_column_name

◆ y_center

◆ y_column_name