Kinetica   C#   API  Version 7.2.3.1
Public Attributes | List of all members
VisualizeIsochroneRequest.Options Struct Reference

A set of string constants for the parameter options. More...

Public Attributes

const string SOLVE_TABLE = "solve_table"
 Name of the table to host intermediate solve results, in [schema_name. More...
 
const string IS_REPLICATED = "is_replicated"
 If set to TRUE, replicate the SOLVE_TABLE. More...
 
const string TRUE = "true"
 Uses the solvers scheduled for 'shortest_path' and 'inverse_shortest_path' based on SOLVE_DIRECTION. More...
 
const string FALSE = "false"
 Uses the solvers 'priority_queue' and 'inverse_priority_queue' based on SOLVE_DIRECTION. More...
 
const string DATA_MIN_X = "data_min_x"
 Lower bound for the x values. More...
 
const string DATA_MAX_X = "data_max_x"
 Upper bound for the x values. More...
 
const string DATA_MIN_Y = "data_min_y"
 Lower bound for the y values. More...
 
const string DATA_MAX_Y = "data_max_y"
 Upper bound for the y values. More...
 
const string CONCAVITY_LEVEL = "concavity_level"
 Factor to qualify the concavity of the isochrone curves. More...
 
const string USE_PRIORITY_QUEUE_SOLVERS = "use_priority_queue_solvers"
 Sets the solver methods explicitly if true. More...
 
const string SOLVE_DIRECTION = "solve_direction"
 Specify whether we are going to the source node, or starting from it. More...
 
const string FROM_SOURCE = "from_source"
 Shortest path to get to the source (inverse Dijkstra). More...
 
const string TO_SOURCE = "to_source"
 Shortest path to source (Dijkstra). More...
 

Detailed Description

A set of string constants for the parameter options.

Additional parameters.

Definition at line 609 of file VisualizeIsochrone.cs.

Member Data Documentation

◆ CONCAVITY_LEVEL

const string VisualizeIsochroneRequest.Options.CONCAVITY_LEVEL = "concavity_level"

Factor to qualify the concavity of the isochrone curves.

The lower the value, the more convex (with '0' being completely convex and '1' being the most concave). The default value is '0.5'. The minimum allowed value is '0'. The maximum allowed value is '1'.

Definition at line 674 of file VisualizeIsochrone.cs.

◆ DATA_MAX_X

const string VisualizeIsochroneRequest.Options.DATA_MAX_X = "data_max_x"

Upper bound for the x values.

If not provided, it will be computed from the bounds of the input data.

Definition at line 656 of file VisualizeIsochrone.cs.

◆ DATA_MAX_Y

const string VisualizeIsochroneRequest.Options.DATA_MAX_Y = "data_max_y"

Upper bound for the y values.

If not provided, it will be computed from the bounds of the input data.

Definition at line 666 of file VisualizeIsochrone.cs.

◆ DATA_MIN_X

const string VisualizeIsochroneRequest.Options.DATA_MIN_X = "data_min_x"

Lower bound for the x values.

If not provided, it will be computed from the bounds of the input data.

Definition at line 651 of file VisualizeIsochrone.cs.

◆ DATA_MIN_Y

const string VisualizeIsochroneRequest.Options.DATA_MIN_Y = "data_min_y"

Lower bound for the y values.

If not provided, it will be computed from the bounds of the input data.

Definition at line 661 of file VisualizeIsochrone.cs.

◆ FALSE

const string VisualizeIsochroneRequest.Options.FALSE = "false"

Uses the solvers 'priority_queue' and 'inverse_priority_queue' based on SOLVE_DIRECTION.

Definition at line 646 of file VisualizeIsochrone.cs.

◆ FROM_SOURCE

const string VisualizeIsochroneRequest.Options.FROM_SOURCE = "from_source"

Shortest path to get to the source (inverse Dijkstra).

Definition at line 720 of file VisualizeIsochrone.cs.

◆ IS_REPLICATED

const string VisualizeIsochroneRequest.Options.IS_REPLICATED = "is_replicated"

If set to TRUE, replicate the SOLVE_TABLE.

Supported values:

The default value is TRUE.

Definition at line 636 of file VisualizeIsochrone.cs.

◆ SOLVE_DIRECTION

const string VisualizeIsochroneRequest.Options.SOLVE_DIRECTION = "solve_direction"

Specify whether we are going to the source node, or starting from it.

Supported values:

  • FROM_SOURCE: Shortest path to get to the source (inverse Dijkstra).
  • TO_SOURCE: Shortest path to source (Dijkstra).

The default value is FROM_SOURCE.

Definition at line 716 of file VisualizeIsochrone.cs.

◆ SOLVE_TABLE

const string VisualizeIsochroneRequest.Options.SOLVE_TABLE = "solve_table"

Name of the table to host intermediate solve results, in [schema_name.

]table_name format, using standard name resolution rules and meeting table naming criteria.

This table will contain the position and cost for each vertex in the graph. If the default value is used, a temporary table is created and deleted once the solution is calculated. The default value is ''.

Definition at line 621 of file VisualizeIsochrone.cs.

◆ TO_SOURCE

const string VisualizeIsochroneRequest.Options.TO_SOURCE = "to_source"

Shortest path to source (Dijkstra).

Definition at line 723 of file VisualizeIsochrone.cs.

◆ TRUE

const string VisualizeIsochroneRequest.Options.TRUE = "true"

Uses the solvers scheduled for 'shortest_path' and 'inverse_shortest_path' based on SOLVE_DIRECTION.

Definition at line 641 of file VisualizeIsochrone.cs.

◆ USE_PRIORITY_QUEUE_SOLVERS

const string VisualizeIsochroneRequest.Options.USE_PRIORITY_QUEUE_SOLVERS = "use_priority_queue_solvers"

Sets the solver methods explicitly if true.

Supported values:

  • TRUE: Uses the solvers scheduled for 'shortest_path' and 'inverse_shortest_path' based on SOLVE_DIRECTION.
  • FALSE: Uses the solvers 'priority_queue' and 'inverse_priority_queue' based on SOLVE_DIRECTION.

The default value is FALSE.

Definition at line 696 of file VisualizeIsochrone.cs.

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