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

Optional parameters. More...

Public Attributes

const string RESTRICTION_THRESHOLD_VALUE = "restriction_threshold_value"
 Value-based restriction comparison. 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 TRUE = "true"
 
const string FALSE = "false"
 
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 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, in [schema_name. 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...
 
const string USE_RTREE = "use_rtree"
 Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges. More...
 
const string LABEL_DELIMITER = "label_delimiter"
 If provided the label string will be split according to this delimiter and each sub-string will be applied as a separate label onto the specified edge. More...
 
const string ALLOW_MULTIPLE_EDGES = "allow_multiple_edges"
 Multigraph choice; allowing multiple edges with the same node pairs if set to true, otherwise, new edges with existing same node pairs will not be inserted. 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.
  • 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.
  • 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, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. This table will have the 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'.
  • USE_RTREE: Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges. Supported values: The default value is TRUE.
  • LABEL_DELIMITER: If provided the label string will be split according to this delimiter and each sub-string will be applied as a separate label onto the specified edge. The default value is ''.
  • ALLOW_MULTIPLE_EDGES: Multigraph choice; allowing multiple edges with the same node pairs if set to true, otherwise, new edges with existing same node pairs will not be inserted. 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 247 of file ModifyGraph.cs.

Member Data Documentation

const string kinetica.ModifyGraphRequest.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 338 of file ModifyGraph.cs.

const string kinetica.ModifyGraphRequest.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 388 of file ModifyGraph.cs.

const string kinetica.ModifyGraphRequest.Options.ALLOW_MULTIPLE_EDGES = "allow_multiple_edges"

Multigraph choice; allowing multiple edges with the same node pairs if set to true, otherwise, new edges with existing same node pairs will not be inserted.

Supported values:

The default value is TRUE.

Definition at line 438 of file ModifyGraph.cs.

const string kinetica.ModifyGraphRequest.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 294 of file ModifyGraph.cs.

const string kinetica.ModifyGraphRequest.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 271 of file ModifyGraph.cs.

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

Definition at line 273 of file ModifyGraph.cs.

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

If specified, the created graph is also created as a table with the given name, in [schema_name.

]table_name format, using standard name resolution rules and meeting table naming criteria. This table will have the 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 350 of file ModifyGraph.cs.

const string kinetica.ModifyGraphRequest.Options.LABEL_DELIMITER = "label_delimiter"

If provided the label string will be split according to this delimiter and each sub-string will be applied as a separate label onto the specified edge.

The default value is ''.

Definition at line 420 of file ModifyGraph.cs.

const string kinetica.ModifyGraphRequest.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 369 of file ModifyGraph.cs.

const string kinetica.ModifyGraphRequest.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 254 of file ModifyGraph.cs.

const string kinetica.ModifyGraphRequest.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 314 of file ModifyGraph.cs.

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

Definition at line 272 of file ModifyGraph.cs.

const string kinetica.ModifyGraphRequest.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 397 of file ModifyGraph.cs.

const string kinetica.ModifyGraphRequest.Options.USE_RTREE = "use_rtree"

Use an range tree structure to accelerate and improve the accuracy of snapping, especially to edges.

Supported values:

The default value is TRUE.

Definition at line 414 of file ModifyGraph.cs.

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