kinetica.FilterByRadiusGeometryRequest

A set of parameters for Kinetica.filterByRadiusGeometry. More…

Inheritance diagram for kinetica.FilterByRadiusGeometryRequest:

Collaboration diagram for kinetica.FilterByRadiusGeometryRequest:

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

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

	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.

	FilterByRadiusGeometryRequest ()
	Constructs a FilterByRadiusGeometryRequest object with default parameters.

	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.

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	column_name `[get, set]`
	Name of the geospatial geometry column to be filtered.

double	x_center `[get, set]`
	Value of the longitude 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.filterByRadiusGeometry.

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 FilterByRadiusGeometryRequest.view_name is passed in as part of the request.

Definition at line 22 of file FilterByRadiusGeometry.cs.

Constructor & Destructor Documentation

◆ FilterByRadiusGeometryRequest() [1/4]

kinetica.FilterByRadiusGeometryRequest.FilterByRadiusGeometryRequest ( )

inline

Constructs a FilterByRadiusGeometryRequest object with default parameters.

Definition at line 162 of file FilterByRadiusGeometry.cs.

◆ FilterByRadiusGeometryRequest() [2/4]

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_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 ”.
column_name	Name of the geospatial geometry column to be filtered.
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_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 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 236 of file FilterByRadiusGeometry.cs.

◆ FilterByRadiusGeometryRequest() [3/4]

kinetica.FilterByRadiusGeometryRequest.FilterByRadiusGeometryRequest ( )

inline

Constructs a FilterByRadiusGeometryRequest object with default parameters.

Definition at line 162 of file FilterByRadiusGeometry.cs.

◆ FilterByRadiusGeometryRequest() [4/4]

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_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 ”.
column_name	Name of the geospatial geometry column to be filtered.
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_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 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 236 of file FilterByRadiusGeometry.cs.

Property Documentation

◆ column_name

string kinetica.FilterByRadiusGeometryRequest.column_name

getset

Name of the geospatial geometry column to be filtered.

Definition at line 94 of file FilterByRadiusGeometry.cs.

◆ options

IDictionary< string, string > kinetica.FilterByRadiusGeometryRequest.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 FilterByRadiusGeometryRequest.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 FilterByRadiusGeometryRequest.view_name and use Kinetica.createSchema 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 158 of file FilterByRadiusGeometry.cs.

◆ radius

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 111 of file FilterByRadiusGeometry.cs.

◆ table_name

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 80 of file FilterByRadiusGeometry.cs.

◆ view_name

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 90 of file FilterByRadiusGeometry.cs.

◆ x_center

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 99 of file FilterByRadiusGeometry.cs.

◆ y_center

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 104 of file FilterByRadiusGeometry.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/FilterByRadiusGeometry.cs
Kinetica/Protocol/FilterByRadiusGeometry.cs

​ Classes

​ Public Member Functions

​ Properties

​ Additional Inherited Members

​Detailed Description

​Constructor & Destructor Documentation

​◆ FilterByRadiusGeometryRequest() [1/4]

​◆ FilterByRadiusGeometryRequest() [2/4]

​◆ FilterByRadiusGeometryRequest() [3/4]

​◆ FilterByRadiusGeometryRequest() [4/4]

​Property Documentation

​◆ column_name

​◆ options

​◆ radius

​◆ table_name

​◆ view_name

​◆ x_center

​◆ y_center

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FilterByRadiusGeometryRequest() [1/4]

◆ FilterByRadiusGeometryRequest() [2/4]

◆ FilterByRadiusGeometryRequest() [3/4]

◆ FilterByRadiusGeometryRequest() [4/4]

Property Documentation

◆ column_name

◆ options

◆ radius

◆ table_name

◆ view_name

◆ x_center

◆ y_center