Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Attributes | List of all members
kinetica.CreateGraphRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string RESTRICTION_THRESHOLD_VALUE = "restriction_threshold_value"
 Value-based restriction comparison. More...
 
const string MERGE_TOLERANCE = "merge_tolerance"
 If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allowed between unique nodes. More...
 
const string MIN_X = "min_x"
 Minimum x (longitude) value for spatial graph associations. More...
 
const string MAX_X = "max_x"
 Maximum x (longitude) value for spatial graph associations. More...
 
const string MIN_Y = "min_y"
 Minimum y (latitude) value for spatial graph associations. More...
 
const string MAX_Y = "max_y"
 Maximum y (latitude) value for spatial graph associations. More...
 
const string RECREATE = "recreate"
 If set to true and the graph (using graph_name) already exists, the graph is deleted and recreated. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string MODIFY = "modify"
 If set to true, recreate is set to true, and the graph (specified using graph_name) already exists, the graph is updated with the given components. More...
 
const string EXPORT_CREATE_RESULTS = "export_create_results"
 If set to true, returns the graph topology in the response as arrays. More...
 
const string ENABLE_GRAPH_DRAW = "enable_graph_draw"
 If set to true, adds a 'EDGE_WKTLINE' column identifier to the specified graph_table so the graph can be viewed via WMS; for social and non-geospatial graphs, the 'EDGE_WKTLINE' column identifier will be populated with spatial coordinates derived from a flattening layout algorithm so the graph can still be viewed. More...
 
const string SAVE_PERSIST = "save_persist"
 If set to true, the graph will be saved in the persist directory (see the config reference for more information). More...
 
const string SYNC_DB = "sync_db"
 If set to true and save_persist is set to true, the graph will be fully reconstructed upon a database restart and be updated to align with any source table(s) updates made since the creation of the graph. More...
 
const string ADD_TABLE_MONITOR = "add_table_monitor"
 Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s). More...
 
const string GRAPH_TABLE = "graph_table"
 If specified, the created graph is also created as a table with the given name and following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. More...
 
const string REMOVE_LABEL_ONLY = "remove_label_only"
 When RESTRICTIONS on labeled entities requested, if set to true this will NOT delete the entity but only the label associated with the entity. More...
 
const string ADD_TURNS = "add_turns"
 Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints. More...
 
const string TURN_ANGLE = "turn_angle"
 Value in degrees modifies the thresholds for attributing right, left, sharp turns, and intersections. More...
 

Detailed Description

Optional parameters.

  • 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 graph.
  • MERGE_TOLERANCE: If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allowed between unique nodes. If nodes are within the tolerance of each other, they will be merged as a single node. The default value is '1.0E-4'.
  • MIN_X: Minimum x (longitude) value for spatial graph associations. The default value is '-180.0'.
  • MAX_X: Maximum x (longitude) value for spatial graph associations. The default value is '180.0'.
  • MIN_Y: Minimum y (latitude) value for spatial graph associations. The default value is '-90.0'.
  • MAX_Y: Maximum y (latitude) value for spatial graph associations. The default value is '90.0'.
  • RECREATE: If set to true and the graph (using ) already exists, the graph is deleted and recreated. Supported values: The default value is FALSE.
  • MODIFY: If set to true, recreate is set to true, and the graph (specified using ) already exists, the graph is updated with the given components. Supported values: The default value is FALSE.
  • EXPORT_CREATE_RESULTS: If set to true, returns the graph topology in the response as arrays. Supported values: The default value is FALSE.
  • ENABLE_GRAPH_DRAW: If set to true, adds a 'EDGE_WKTLINE' column identifier to the specified graph_table so the graph can be viewed via WMS; for social and non-geospatial graphs, the 'EDGE_WKTLINE' column identifier will be populated with spatial coordinates derived from a flattening layout algorithm so the graph can still be viewed. Supported values: The default value is FALSE.
  • SAVE_PERSIST: If set to true, the graph will be saved in the persist directory (see the config reference for more information). If set to false, the graph will be removed when the graph server is shutdown. Supported values: The default value is FALSE.
  • SYNC_DB: If set to true and save_persist is set to true, the graph will be fully reconstructed upon a database restart and be updated to align with any source table(s) updates made since the creation of the graph. If dynamic graph updates upon table inserts are desired, use add_table_monitor instead. Supported values: The default value is FALSE.
  • ADD_TABLE_MONITOR: Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s). Note that upon database restart, if save_persist is also set to true, the graph will be fully reconstructed and the table monitors will be reattached. For more details on table monitors, see /create/tablemonitor. Supported values: The default value is FALSE.
  • GRAPH_TABLE: If specified, the created graph is also created as a table with the given name and following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'. If left blank, no table is created. The default value is ''.
  • REMOVE_LABEL_ONLY: When RESTRICTIONS on labeled entities requested, if set to true this will NOT delete the entity but only the label associated with the entity. Otherwise (default), it'll delete the label AND the entity. Supported values: The default value is FALSE.
  • ADD_TURNS: Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints. (increases the total number of edges). Supported values: The default value is FALSE.
  • TURN_ANGLE: Value in degrees modifies the thresholds for attributing right, left, sharp turns, and intersections. It is the vertical deviation angle from the incoming edge to the intersection node. The larger the value, the larger the threshold for sharp turns and intersections; the smaller the value, the larger the threshold for right and left turns; 0 < turn_angle < 90. The default value is '60'.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 319 of file CreateGraph.cs.

Member Data Documentation

const string kinetica.CreateGraphRequest.Options.ADD_TABLE_MONITOR = "add_table_monitor"

Adds a table monitor to every table used in the creation of the graph; this table monitor will trigger the graph to update dynamically upon inserts to the source table(s).

Note that upon database restart, if save_persist is also set to true, the graph will be fully reconstructed and the table monitors will be reattached. For more details on table monitors, see Kinetica.createTableMonitor(string,IDictionary{string, string}). Supported values:

The default value is FALSE.

Definition at line 491 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.ADD_TURNS = "add_turns"

Adds dummy 'pillowed' edges around intersection nodes where there are more than three edges so that additional weight penalties can be imposed by the solve endpoints.

(increases the total number of edges). Supported values:

The default value is FALSE.

Definition at line 535 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.ENABLE_GRAPH_DRAW = "enable_graph_draw"

If set to true, adds a 'EDGE_WKTLINE' column identifier to the specified graph_table so the graph can be viewed via WMS; for social and non-geospatial graphs, the 'EDGE_WKTLINE' column identifier will be populated with spatial coordinates derived from a flattening layout algorithm so the graph can still be viewed.

Supported values:

The default value is FALSE.

Definition at line 426 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.EXPORT_CREATE_RESULTS = "export_create_results"

If set to true, returns the graph topology in the response as arrays.

Supported values:

The default value is FALSE.

Definition at line 405 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.FALSE = "false"

Definition at line 369 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.GRAPH_TABLE = "graph_table"

If specified, the created graph is also created as a table with the given name and following identifier columns: 'EDGE_ID', 'EDGE_NODE1_ID', 'EDGE_NODE2_ID'.

If left blank, no table is created. The default value is ''.

Definition at line 497 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.MAX_X = "max_x"

Maximum x (longitude) value for spatial graph associations.

The default value is '180.0'.

Definition at line 341 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.MAX_Y = "max_y"

Maximum y (latitude) value for spatial graph associations.

The default value is '90.0'.

Definition at line 349 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.MERGE_TOLERANCE = "merge_tolerance"

If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allowed between unique nodes.

If nodes are within the tolerance of each other, they will be merged as a single node. The default value is '1.0E-4'.

Definition at line 333 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.MIN_X = "min_x"

Minimum x (longitude) value for spatial graph associations.

The default value is '-180.0'.

Definition at line 337 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.MIN_Y = "min_y"

Minimum y (latitude) value for spatial graph associations.

The default value is '-90.0'.

Definition at line 345 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.MODIFY = "modify"

If set to true, recreate is set to true, and the graph (specified using graph_name) already exists, the graph is updated with the given components.

Supported values:

The default value is FALSE.

Definition at line 388 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.RECREATE = "recreate"

If set to true and the graph (using graph_name) already exists, the graph is deleted and recreated.

Supported values:

The default value is FALSE.

Definition at line 367 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.REMOVE_LABEL_ONLY = "remove_label_only"

When RESTRICTIONS on labeled entities requested, if set to true this will NOT delete the entity but only the label associated with the entity.

Otherwise (default), it'll delete the label AND the entity. Supported values:

The default value is FALSE.

Definition at line 516 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.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 graph.

Definition at line 326 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.SAVE_PERSIST = "save_persist"

If set to true, the graph will be saved in the persist directory (see the config reference for more information).

If set to false, the graph will be removed when the graph server is shutdown. Supported values:

The default value is FALSE.

Definition at line 446 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.SYNC_DB = "sync_db"

If set to true and save_persist is set to true, the graph will be fully reconstructed upon a database restart and be updated to align with any source table(s) updates made since the creation of the graph.

If dynamic graph updates upon table inserts are desired, use add_table_monitor instead. Supported values:

The default value is FALSE.

Definition at line 467 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.TRUE = "true"

Definition at line 368 of file CreateGraph.cs.

const string kinetica.CreateGraphRequest.Options.TURN_ANGLE = "turn_angle"

Value in degrees modifies the thresholds for attributing right, left, sharp turns, and intersections.

It is the vertical deviation angle from the incoming edge to the intersection node. The larger the value, the larger the threshold for sharp turns and intersections; the smaller the value, the larger the threshold for right and left turns; 0 < turn_angle < 90. The default value is '60'.

Definition at line 544 of file CreateGraph.cs.

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