Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
CreateGraph.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 
10 
11 namespace kinetica
12 {
13 
31  {
32 
52  public struct DirectedGraph
53  {
54  public const string TRUE = "true";
55  public const string FALSE = "false";
56  } // end struct DirectedGraph
57 
58 
319  public struct Options
320  {
321 
326  public const string RESTRICTION_THRESHOLD_VALUE = "restriction_threshold_value";
327 
333  public const string MERGE_TOLERANCE = "merge_tolerance";
334 
337  public const string MIN_X = "min_x";
338 
341  public const string MAX_X = "max_x";
342 
345  public const string MIN_Y = "min_y";
346 
349  public const string MAX_Y = "max_y";
350 
367  public const string RECREATE = "recreate";
368  public const string TRUE = "true";
369  public const string FALSE = "false";
370 
388  public const string MODIFY = "modify";
389 
405  public const string EXPORT_CREATE_RESULTS = "export_create_results";
406 
426  public const string ENABLE_GRAPH_DRAW = "enable_graph_draw";
427 
446  public const string SAVE_PERSIST = "save_persist";
447 
467  public const string SYNC_DB = "sync_db";
468 
491  public const string ADD_TABLE_MONITOR = "add_table_monitor";
492 
497  public const string GRAPH_TABLE = "graph_table";
498 
516  public const string REMOVE_LABEL_ONLY = "remove_label_only";
517 
535  public const string ADD_TURNS = "add_turns";
536 
544  public const string TURN_ANGLE = "turn_angle";
545  } // end struct Options
546 
547 
549  public string graph_name { get; set; }
550 
569  public bool directed_graph { get; set; } = true;
570 
586  public IList<string> nodes { get; set; } = new List<string>();
587 
604  public IList<string> edges { get; set; } = new List<string>();
605 
624  public IList<string> weights { get; set; } = new List<string>();
625 
642  public IList<string> restrictions { get; set; } = new List<string>();
643 
902  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
903 
904 
907  public CreateGraphRequest() { }
908 
1259  bool? directed_graph,
1260  IList<string> nodes,
1261  IList<string> edges,
1262  IList<string> weights,
1263  IList<string> restrictions,
1264  IDictionary<string, string> options = null)
1265  {
1266  this.graph_name = graph_name ?? "";
1267  this.directed_graph = directed_graph ?? true;
1268  this.nodes = nodes ?? new List<string>();
1269  this.edges = edges ?? new List<string>();
1270  this.weights = weights ?? new List<string>();
1271  this.restrictions = restrictions ?? new List<string>();
1272  this.options = options ?? new Dictionary<string, string>();
1273  } // end constructor
1274 
1275  } // end class CreateGraphRequest
1276 
1277 
1278 
1283  {
1284 
1286  public long num_nodes { get; set; }
1287 
1289  public long num_edges { get; set; }
1290 
1293  public IList<long> edges_ids { get; set; } = new List<long>();
1294 
1296  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1297 
1298  } // end class CreateGraphResponse
1299 
1300 
1301 
1302 
1303 } // end namespace kinetica
IDictionary< string, string > info
Additional information.
long num_edges
Total number of edges created.
const string EXPORT_CREATE_RESULTS
If set to true, returns the graph topology in the response as arrays.
Definition: CreateGraph.cs:405
const string MIN_Y
Minimum y (latitude) value for spatial graph associations.
Definition: CreateGraph.cs:345
IList< string > weights
Weights represent a method of informing the graph solver of the cost of including a given edge in a s...
Definition: CreateGraph.cs:624
IList< long > edges_ids
Edges given as pairs of node indices.
const string ADD_TURNS
Adds dummy &#39;pillowed&#39; edges around intersection nodes where there are more than three edges so that a...
Definition: CreateGraph.cs:535
If set to true, the graph will be directed.
Definition: CreateGraph.cs:52
CreateGraphRequest(string graph_name, bool?directed_graph, IList< string > nodes, IList< string > edges, IList< string > weights, IList< string > restrictions, IDictionary< string, string > options=null)
Constructs a CreateGraphRequest object with the specified parameters.
const string SYNC_DB
If set to true and save_persist is set to true, the graph will be fully reconstructed upon a database...
Definition: CreateGraph.cs:467
const string MIN_X
Minimum x (longitude) value for spatial graph associations.
Definition: CreateGraph.cs:337
long num_nodes
Total number of nodes created.
const string REMOVE_LABEL_ONLY
When RESTRICTIONS on labeled entities requested, if set to true this will NOT delete the entity but o...
Definition: CreateGraph.cs:516
const string RECREATE
If set to true and the graph (using graph_name) already exists, the graph is deleted and recreated...
Definition: CreateGraph.cs:367
IList< string > nodes
Nodes represent fundamental topological units of a graph.
Definition: CreateGraph.cs:586
const string TURN_ANGLE
Value in degrees modifies the thresholds for attributing right, left, sharp turns, and intersections.
Definition: CreateGraph.cs:544
CreateGraphRequest()
Constructs a CreateGraphRequest object with default parameters.
Definition: CreateGraph.cs:907
A set of parameters for Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}).
Definition: CreateGraph.cs:30
IDictionary< string, string > options
Optional parameters.
Definition: CreateGraph.cs:902
const string RESTRICTION_THRESHOLD_VALUE
Value-based restriction comparison.
Definition: CreateGraph.cs:326
string graph_name
Name of the graph resource to generate.
Definition: CreateGraph.cs:549
const string MAX_Y
Maximum y (latitude) value for spatial graph associations.
Definition: CreateGraph.cs:349
A set of results returned by Kinetica.createGraph(string,bool,IList{string},IList{string},IList{string},IList{string},IDictionary{string, string}).
const string MERGE_TOLERANCE
If node geospatial positions are input (e.g., WKTPOINT, X, Y), determines the minimum separation allo...
Definition: CreateGraph.cs:333
const string MODIFY
If set to true, recreate is set to true, and the graph (specified using graph_name) already exists...
Definition: CreateGraph.cs:388
const string GRAPH_TABLE
If specified, the created graph is also created as a table with the given name and following identifi...
Definition: CreateGraph.cs:497
const string SAVE_PERSIST
If set to true, the graph will be saved in the persist directory (see the config reference for more i...
Definition: CreateGraph.cs:446
IList< string > edges
Edges represent the required fundamental topological unit of a graph that typically connect nodes...
Definition: CreateGraph.cs:604
const string ADD_TABLE_MONITOR
Adds a table monitor to every table used in the creation of the graph; this table monitor will trigge...
Definition: CreateGraph.cs:491
const string MAX_X
Maximum x (longitude) value for spatial graph associations.
Definition: CreateGraph.cs:341
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string ENABLE_GRAPH_DRAW
If set to true, adds a &#39;EDGE_WKTLINE&#39; column identifier to the specified graph_table so the graph can...
Definition: CreateGraph.cs:426
bool directed_graph
If set to true, the graph will be directed.
Definition: CreateGraph.cs:569
IList< string > restrictions
Restrictions represent a method of informing the graph solver which edges and/or nodes should be igno...
Definition: CreateGraph.cs:642