|
Kinetica C# API
Version 7.0.19.0
|
|
Kinetica C# API
Version 7.0.19.0
|
Additional parameters
Public Attributes | |
| const string | MAX_SOLUTION_RADIUS = "max_solution_radius" |
| For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. More... | |
| const string | MIN_SOLUTION_RADIUS = "min_solution_radius" |
| For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. More... | |
| const string | MAX_SOLUTION_TARGETS = "max_solution_targets" |
| For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. More... | |
| const string | EXPORT_SOLVE_RESULTS = "export_solve_results" |
| Returns solution results inside the <member name="result_per_destination_node"> array in the response if set to true. More... | |
| const string | TRUE = "true" |
| const string | FALSE = "false" |
| const string | REMOVE_PREVIOUS_RESTRICTIONS = "remove_previous_restrictions" |
| Ignore the restrictions applied to the graph during the creation stage and only use the restrictions specified in this request if set to true. More... | |
| const string | RESTRICTION_THRESHOLD_VALUE = "restriction_threshold_value" |
| Value-based restriction comparison. More... | |
| const string | UNIFORM_WEIGHTS = "uniform_weights" |
| When specified, assigns the given value to all the edges in the graph. More... | |
| const string | LEFT_TURN_PENALTY = "left_turn_penalty" |
| This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation. More... | |
| const string | RIGHT_TURN_PENALTY = "right_turn_penalty" |
| This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation. More... | |
| const string | INTERSECTION_PENALTY = "intersection_penalty" |
| This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation. More... | |
| const string | SHARP_TURN_PENALTY = "sharp_turn_penalty" |
| This will add an additonal weight over the edges labelled as 'sharp turn' or 'u-turn' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation. More... | |
| const string | NUM_BEST_PATHS = "num_best_paths" |
| For MULTIPLE_ROUTING solvers only; sets the number of shortest paths computed from each node. More... | |
| const string | MAX_NUM_COMBINATIONS = "max_num_combinations" |
| For MULTIPLE_ROUTING solvers only; sets the cap on the combinatorial sequences generated. More... | |
| const string | ACCURATE_SNAPS = "accurate_snaps" |
| Valid for single source destination pair solves if points are described in NODE_WKTPOINT identifier types: When true (default), it snaps to the nearest node of the graph; otherwise, it searches for the closest entity that could be an edge. More... | |
| const string | OUTPUT_EDGE_PATH = "output_edge_path" |
| If true then concatenated edge ids will be added as the EDGE path column of the solution table for each source and target pair in shortest path solves. More... | |
| const string | OUTPUT_WKT_PATH = "output_wkt_path" |
| If true then concatenated wkt line segments will be added as the Wktroute column of the solution table for each source and target pair in shortest path solves. More... | |
Additional parameters
Sets the maximum solution cost radius, which ignores the list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'. MIN_SOLUTION_RADIUS: For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Applicable only when max_solution_radius is set. Sets the minimum solution cost radius, which ignores the list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'. MAX_SOLUTION_TARGETS: For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only. Sets the maximum number of solution targets, which ignores the list and instead outputs no more than n number of nodes sorted by ascending cost where n is equal to the setting value. If set to 0, the setting is ignored. The default value is '0'. EXPORT_SOLVE_RESULTS: Returns solution results inside the <member name="result_per_destination_node"> array in the response if set to true. Supported values:
The default value is FALSE. REMOVE_PREVIOUS_RESTRICTIONS: Ignore the restrictions applied to the graph during the creation stage and only use the restrictions specified in this request if set to true. Supported values:
The default value is FALSE. RESTRICTION_THRESHOLD_VALUE: Value-based restriction comparison. Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the solution. UNIFORM_WEIGHTS: When specified, assigns the given value to all the edges in the graph. Note that weights provided in will override this value. LEFT_TURN_PENALTY: This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'. RIGHT_TURN_PENALTY: This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'. INTERSECTION_PENALTY: This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'. SHARP_TURN_PENALTY: This will add an additonal weight over the edges labelled as 'sharp turn' or 'u-turn' if the 'add_turn' option parameter of the /create/graph was invoked at graph creation. The default value is '0.0'. NUM_BEST_PATHS: For MULTIPLE_ROUTING solvers only; sets the number of shortest paths computed from each node. This is the heuristic criterion. Default value of zero allows the number to be computed automatically by the solver. The user may want to override this parameter to speed-up the solver. The default value is '0'. MAX_NUM_COMBINATIONS: For MULTIPLE_ROUTING solvers only; sets the cap on the combinatorial sequences generated. If the default value of two millions is overridden to a lesser value, it can potentially speed up the solver. The default value is '2000000'. ACCURATE_SNAPS: Valid for single source destination pair solves if points are described in NODE_WKTPOINT identifier types: When true (default), it snaps to the nearest node of the graph; otherwise, it searches for the closest entity that could be an edge. For the latter case (false), the solver modifies the resulting cost with the weights proportional to the ratio of the snap location within the edge. This may be an over-kill when the performance is considered and the difference is well less than 1 percent. In batch runs, since the performance is of utmost importance, the option is always considered 'false'. Supported values:
The default value is TRUE. OUTPUT_EDGE_PATH: If true then concatenated edge ids will be added as the EDGE path column of the solution table for each source and target pair in shortest path solves. Supported values:
The default value is FALSE. OUTPUT_WKT_PATH: If true then concatenated wkt line segments will be added as the Wktroute column of the solution table for each source and target pair in shortest path solves. Supported values:
The default value is TRUE.
The default value is an empty Dictionary. A set of string constants for the parameter options.
Definition at line 363 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.ACCURATE_SNAPS = "accurate_snaps" |
Valid for single source destination pair solves if points are described in NODE_WKTPOINT identifier types: When true (default), it snaps to the nearest node of the graph; otherwise, it searches for the closest entity that could be an edge.
For the latter case (false), the solver modifies the resulting cost with the weights proportional to the ratio of the snap location within the edge. This may be an over-kill when the performance is considered and the difference is well less than 1 percent. In batch runs, since the performance is of utmost importance, the option is always considered 'false'. Supported values:
The default value is TRUE.
Definition at line 511 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.EXPORT_SOLVE_RESULTS = "export_solve_results" |
Returns solution results inside the <member name="result_per_destination_node"> array in the response if set to true.
Supported values:
The default value is FALSE.
Definition at line 408 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.FALSE = "false" |
Definition at line 410 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.INTERSECTION_PENALTY = "intersection_penalty" |
This will add an additonal weight over the edges labelled as 'intersection' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation.
The default value is '0.0'.
Definition at line 463 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.LEFT_TURN_PENALTY = "left_turn_penalty" |
This will add an additonal weight over the edges labelled as 'left turn' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation.
The default value is '0.0'.
Definition at line 447 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.MAX_NUM_COMBINATIONS = "max_num_combinations" |
For MULTIPLE_ROUTING solvers only; sets the cap on the combinatorial sequences generated.
If the default value of two millions is overridden to a lesser value, it can potentially speed up the solver. The default value is '2000000'.
Definition at line 486 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.MAX_SOLUTION_RADIUS = "max_solution_radius" |
For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Sets the maximum solution cost radius, which ignores the destination_nodes list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'.
Definition at line 372 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.MAX_SOLUTION_TARGETS = "max_solution_targets" |
For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Sets the maximum number of solution targets, which ignores the destination_nodes list and instead outputs no more than n number of nodes sorted by ascending cost where n is equal to the setting value. If set to 0, the setting is ignored. The default value is '0'.
Definition at line 390 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.MIN_SOLUTION_RADIUS = "min_solution_radius" |
For SHORTEST_PATH and INVERSE_SHORTEST_PATH solvers only.
Applicable only when max_solution_radius is set. Sets the minimum solution cost radius, which ignores the destination_nodes list and instead outputs the nodes within the radius sorted by ascending cost. If set to '0.0', the setting is ignored. The default value is '0.0'.
Definition at line 381 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.NUM_BEST_PATHS = "num_best_paths" |
For MULTIPLE_ROUTING solvers only; sets the number of shortest paths computed from each node.
This is the heuristic criterion. Default value of zero allows the number to be computed automatically by the solver. The user may want to override this parameter to speed-up the solver. The default value is '0'.
Definition at line 479 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.OUTPUT_EDGE_PATH = "output_edge_path" |
If true then concatenated edge ids will be added as the EDGE path column of the solution table for each source and target pair in shortest path solves.
Supported values:
The default value is FALSE.
Definition at line 529 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.OUTPUT_WKT_PATH = "output_wkt_path" |
If true then concatenated wkt line segments will be added as the Wktroute column of the solution table for each source and target pair in shortest path solves.
Supported values:
The default value is TRUE.
Definition at line 547 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.REMOVE_PREVIOUS_RESTRICTIONS = "remove_previous_restrictions" |
Ignore the restrictions applied to the graph during the creation stage and only use the restrictions specified in this request if set to true.
Supported values:
The default value is FALSE.
Definition at line 428 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.RESTRICTION_THRESHOLD_VALUE = "restriction_threshold_value" |
Value-based restriction comparison.
Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the solution.
Definition at line 434 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.RIGHT_TURN_PENALTY = "right_turn_penalty" |
This will add an additonal weight over the edges labelled as' right turn' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation.
The default value is '0.0'.
Definition at line 455 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.SHARP_TURN_PENALTY = "sharp_turn_penalty" |
This will add an additonal weight over the edges labelled as 'sharp turn' or 'u-turn' if the 'add_turn' option parameter of the Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}) was invoked at graph creation.
The default value is '0.0'.
Definition at line 471 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.TRUE = "true" |
Definition at line 409 of file SolveGraph.cs.
| const string kinetica.SolveGraphRequest.Options.UNIFORM_WEIGHTS = "uniform_weights" |
When specified, assigns the given value to all the edges in the graph.
Note that weights provided in weights_on_edges will override this value.
Definition at line 439 of file SolveGraph.cs.
1.8.5 
