ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkSQLGraphReader Class Reference

vtkSQLGraphReader - read a vtkGraph from a database More...

Inheritance diagram for Kitware.VTK.vtkSQLGraphReader:
[legend]
Collaboration diagram for Kitware.VTK.vtkSQLGraphReader:
[legend]

List of all members.

Public Member Functions

 vtkSQLGraphReader (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkSQLGraphReader ()
 Undocumented Block.
virtual void CollapseEdgesOff ()
 When set, creates a graph with no parallel arcs. Parallel arcs are combined into one arc. No cell fields are passed to the output, except the vtkGhostLevels array if it exists, but a new field "weight" is created that holds the number of duplicates of that arc in the input.
virtual void CollapseEdgesOn ()
 When set, creates a graph with no parallel arcs. Parallel arcs are combined into one arc. No cell fields are passed to the output, except the vtkGhostLevels array if it exists, but a new field "weight" is created that holds the number of duplicates of that arc in the input.
virtual void DirectedOff ()
 When set, creates a directed graph, as opposed to an undirected graph.
virtual void DirectedOn ()
 When set, creates a directed graph, as opposed to an undirected graph.
virtual bool GetCollapseEdges ()
 When set, creates a graph with no parallel arcs. Parallel arcs are combined into one arc. No cell fields are passed to the output, except the vtkGhostLevels array if it exists, but a new field "weight" is created that holds the number of duplicates of that arc in the input.
virtual bool GetDirected ()
 When set, creates a directed graph, as opposed to an undirected graph.
virtual vtkSQLQuery GetEdgeQuery ()
 The query that retrieves the arc information.
virtual string GetSourceField ()
 The name of the field in the arc query for the source node of each arc.
virtual string GetTargetField ()
 The name of the field in the arc query for the target node of each arc.
virtual string GetVertexIdField ()
 The name of the field in the node query for the node ID.
virtual vtkSQLQuery GetVertexQuery ()
 The query that retrieves the node information.
virtual string GetXField ()
 The name of the field in the node query for the node's x coordinate.
virtual string GetYField ()
 The name of the field in the node query for the node's y coordinate.
virtual string GetZField ()
 The name of the field in the node query for the node's z coordinate.
override int IsA (string type)
 Undocumented Block.
new vtkSQLGraphReader NewInstance ()
 Undocumented Block.
virtual void SetCollapseEdges (bool _arg)
 When set, creates a graph with no parallel arcs. Parallel arcs are combined into one arc. No cell fields are passed to the output, except the vtkGhostLevels array if it exists, but a new field "weight" is created that holds the number of duplicates of that arc in the input.
virtual void SetDirected (bool _arg)
 When set, creates a directed graph, as opposed to an undirected graph.
virtual void SetEdgeQuery (vtkSQLQuery q)
 The query that retrieves the arc information.
virtual void SetSourceField (string _arg)
 The name of the field in the arc query for the source node of each arc.
virtual void SetTargetField (string _arg)
 The name of the field in the arc query for the target node of each arc.
virtual void SetVertexIdField (string _arg)
 The name of the field in the node query for the node ID.
virtual void SetVertexQuery (vtkSQLQuery q)
 The query that retrieves the node information.
virtual void SetXField (string _arg)
 The name of the field in the node query for the node's x coordinate.
virtual void SetYField (string _arg)
 The name of the field in the node query for the node's y coordinate.
virtual void SetZField (string _arg)
 The name of the field in the node query for the node's z coordinate.

Static Public Member Functions

static new vtkSQLGraphReader New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkSQLGraphReader SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkSQLGraphReader"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "17vtkSQLGraphReader"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkSQLGraphReader_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSQLGraphReader_CollapseEdgesOff_01 (HandleRef pThis)
static internal void vtkSQLGraphReader_CollapseEdgesOn_02 (HandleRef pThis)
static internal void vtkSQLGraphReader_DirectedOff_03 (HandleRef pThis)
static internal void vtkSQLGraphReader_DirectedOn_04 (HandleRef pThis)
static internal byte vtkSQLGraphReader_GetCollapseEdges_05 (HandleRef pThis)
static internal byte vtkSQLGraphReader_GetDirected_06 (HandleRef pThis)
static internal IntPtr vtkSQLGraphReader_GetEdgeQuery_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkSQLGraphReader_GetSourceField_08 (HandleRef pThis)
static internal IntPtr vtkSQLGraphReader_GetTargetField_09 (HandleRef pThis)
static internal IntPtr vtkSQLGraphReader_GetVertexIdField_10 (HandleRef pThis)
static internal IntPtr vtkSQLGraphReader_GetVertexQuery_11 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkSQLGraphReader_GetXField_12 (HandleRef pThis)
static internal IntPtr vtkSQLGraphReader_GetYField_13 (HandleRef pThis)
static internal IntPtr vtkSQLGraphReader_GetZField_14 (HandleRef pThis)
static internal int vtkSQLGraphReader_IsA_15 (HandleRef pThis, string type)
static internal int vtkSQLGraphReader_IsTypeOf_16 (string type)
static internal IntPtr vtkSQLGraphReader_NewInstance_18 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkSQLGraphReader_SafeDownCast_19 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSQLGraphReader_SetCollapseEdges_20 (HandleRef pThis, byte _arg)
static internal void vtkSQLGraphReader_SetDirected_21 (HandleRef pThis, byte _arg)
static internal void vtkSQLGraphReader_SetEdgeQuery_22 (HandleRef pThis, HandleRef q)
static internal void vtkSQLGraphReader_SetSourceField_23 (HandleRef pThis, string _arg)
static internal void vtkSQLGraphReader_SetTargetField_24 (HandleRef pThis, string _arg)
static internal void vtkSQLGraphReader_SetVertexIdField_25 (HandleRef pThis, string _arg)
static internal void vtkSQLGraphReader_SetVertexQuery_26 (HandleRef pThis, HandleRef q)
static internal void vtkSQLGraphReader_SetXField_27 (HandleRef pThis, string _arg)
static internal void vtkSQLGraphReader_SetYField_28 (HandleRef pThis, string _arg)
static internal void vtkSQLGraphReader_SetZField_29 (HandleRef pThis, string _arg)

Static Private Member Functions

static vtkSQLGraphReader ()
 Automatically generated type registration mechanics.

Detailed Description

vtkSQLGraphReader - read a vtkGraph from a database

Description

Creates a vtkGraph using one or two vtkSQLQuery's. The first (required) query must have one row for each arc in the graph. The query must have two columns which represent the source and target node ids.

The second (optional) query has one row for each node in the graph. The table must have a field whose values match those in the arc table. If the node table is not given, a node will be created for each unique source or target identifier in the arc table.

The source, target, and node ID fields must be of the same type, and must be either vtkStringArray or a subclass of vtkDataArray.

All columns in the queries, including the source, target, and node index fields, are copied into the arc data and node data of the resulting vtkGraph. If the node query is not given, the node data will contain a single "id" column with the same type as the source/target id arrays.

If parallel arcs are collected, not all the arc data is not copied into the output. Only the source and target id arrays will be transferred. An additional vtkIdTypeArray column called "weight" is created which contains the number of times each arc appeared in the input.

If the node query contains positional data, the user may specify the names of these fields. These arrays must be data arrays. The z-coordinate array is optional, and if not given the z-coordinates are set to zero.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

When set, creates a graph with no parallel arcs. Parallel arcs are combined into one arc. No cell fields are passed to the output, except the vtkGhostLevels array if it exists, but a new field "weight" is created that holds the number of duplicates of that arc in the input.

When set, creates a graph with no parallel arcs. Parallel arcs are combined into one arc. No cell fields are passed to the output, except the vtkGhostLevels array if it exists, but a new field "weight" is created that holds the number of duplicates of that arc in the input.

virtual void Kitware.VTK.vtkSQLGraphReader.DirectedOff ( ) [virtual]

When set, creates a directed graph, as opposed to an undirected graph.

virtual void Kitware.VTK.vtkSQLGraphReader.DirectedOn ( ) [virtual]

When set, creates a directed graph, as opposed to an undirected graph.

override void Kitware.VTK.vtkSQLGraphReader.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkGraphAlgorithm.

When set, creates a graph with no parallel arcs. Parallel arcs are combined into one arc. No cell fields are passed to the output, except the vtkGhostLevels array if it exists, but a new field "weight" is created that holds the number of duplicates of that arc in the input.

virtual bool Kitware.VTK.vtkSQLGraphReader.GetDirected ( ) [virtual]

When set, creates a directed graph, as opposed to an undirected graph.

The query that retrieves the arc information.

Here is the call graph for this function:

virtual string Kitware.VTK.vtkSQLGraphReader.GetSourceField ( ) [virtual]

The name of the field in the arc query for the source node of each arc.

virtual string Kitware.VTK.vtkSQLGraphReader.GetTargetField ( ) [virtual]

The name of the field in the arc query for the target node of each arc.

virtual string Kitware.VTK.vtkSQLGraphReader.GetVertexIdField ( ) [virtual]

The name of the field in the node query for the node ID.

The query that retrieves the node information.

Here is the call graph for this function:

virtual string Kitware.VTK.vtkSQLGraphReader.GetXField ( ) [virtual]

The name of the field in the node query for the node's x coordinate.

virtual string Kitware.VTK.vtkSQLGraphReader.GetYField ( ) [virtual]

The name of the field in the node query for the node's y coordinate.

virtual string Kitware.VTK.vtkSQLGraphReader.GetZField ( ) [virtual]

The name of the field in the node query for the node's z coordinate.

override int Kitware.VTK.vtkSQLGraphReader.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkGraphAlgorithm.

static new int Kitware.VTK.vtkSQLGraphReader.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkGraphAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkGraphAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkGraphAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkGraphAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkSQLGraphReader.SetCollapseEdges ( bool  _arg) [virtual]

When set, creates a graph with no parallel arcs. Parallel arcs are combined into one arc. No cell fields are passed to the output, except the vtkGhostLevels array if it exists, but a new field "weight" is created that holds the number of duplicates of that arc in the input.

virtual void Kitware.VTK.vtkSQLGraphReader.SetDirected ( bool  _arg) [virtual]

When set, creates a directed graph, as opposed to an undirected graph.

The query that retrieves the arc information.

virtual void Kitware.VTK.vtkSQLGraphReader.SetSourceField ( string  _arg) [virtual]

The name of the field in the arc query for the source node of each arc.

virtual void Kitware.VTK.vtkSQLGraphReader.SetTargetField ( string  _arg) [virtual]

The name of the field in the arc query for the target node of each arc.

virtual void Kitware.VTK.vtkSQLGraphReader.SetVertexIdField ( string  _arg) [virtual]

The name of the field in the node query for the node ID.

The query that retrieves the node information.

virtual void Kitware.VTK.vtkSQLGraphReader.SetXField ( string  _arg) [virtual]

The name of the field in the node query for the node's x coordinate.

virtual void Kitware.VTK.vtkSQLGraphReader.SetYField ( string  _arg) [virtual]

The name of the field in the node query for the node's y coordinate.

virtual void Kitware.VTK.vtkSQLGraphReader.SetZField ( string  _arg) [virtual]

The name of the field in the node query for the node's z coordinate.

static internal void Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_CollapseEdgesOff_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_CollapseEdgesOn_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_DirectedOff_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_DirectedOn_04 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_GetCollapseEdges_05 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_GetDirected_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_GetEdgeQuery_07 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_GetSourceField_08 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_GetTargetField_09 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_GetVertexIdField_10 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_GetVertexQuery_11 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_GetXField_12 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_GetYField_13 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_GetZField_14 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_IsA_15 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_IsTypeOf_16 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_NewInstance_18 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_SafeDownCast_19 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_SetCollapseEdges_20 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_SetDirected_21 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_SetEdgeQuery_22 ( HandleRef  pThis,
HandleRef  q 
) [private]
static internal void Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_SetSourceField_23 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_SetTargetField_24 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_SetVertexIdField_25 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_SetVertexQuery_26 ( HandleRef  pThis,
HandleRef  q 
) [private]
static internal void Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_SetXField_27 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_SetYField_28 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkSQLGraphReader.vtkSQLGraphReader_SetZField_29 ( HandleRef  pThis,
string  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkSQLGraphReader.MRClassNameKey = "17vtkSQLGraphReader" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkGraphAlgorithm.

new const string Kitware.VTK.vtkSQLGraphReader.MRFullTypeName = "Kitware.VTK.vtkSQLGraphReader"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkGraphAlgorithm.


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