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.vtkTableToGraph Class Reference

vtkTableToGraph - convert a vtkTable into a vtkGraph More...

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

List of all members.

Public Member Functions

 vtkTableToGraph (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkTableToGraph ()
 Undocumented Block.
void AddLinkEdge (string column1, string column2)
 Add an edge to the link graph. Specify the names of the columns to link.
void AddLinkVertex (string column, string domain, int hidden)
 Add a vertex to the link graph. Specify the column name, the domain name for the column, and whether the column is hidden.
void ClearLinkEdges ()
 Clear the link graph edges. The graph vertices will remain.
void ClearLinkVertices ()
 Clear the link graph vertices. This also clears all edges.
virtual void DirectedOff ()
 Specify the directedness of the output graph.
virtual void DirectedOn ()
 Specify the directedness of the output graph.
virtual bool GetDirected ()
 Specify the directedness of the output graph.
virtual vtkMutableDirectedGraph GetLinkGraph ()
 The graph describing how to link the columns in the table.
override uint GetMTime ()
 Get the current modified time.
override int IsA (string type)
 Undocumented Block.
void LinkColumnPath (vtkStringArray column, vtkStringArray domain, vtkBitArray hidden)
 Links the columns in a specific order. This creates a simple path as the link graph.
new vtkTableToGraph NewInstance ()
 Undocumented Block.
virtual void SetDirected (bool _arg)
 Specify the directedness of the output graph.
void SetLinkGraph (vtkMutableDirectedGraph g)
 The graph describing how to link the columns in the table.
void SetVertexTableConnection (vtkAlgorithmOutput arg0)
 A convenience method for setting the vertex table input. This is mainly for the benefit of the VTK client/server layer, vanilla VTK code should use e.g:

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "15vtkTableToGraph"
 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 vtkTableToGraph_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTableToGraph_AddLinkEdge_01 (HandleRef pThis, string column1, string column2)
static internal void vtkTableToGraph_AddLinkVertex_02 (HandleRef pThis, string column, string domain, int hidden)
static internal void vtkTableToGraph_ClearLinkEdges_03 (HandleRef pThis)
static internal void vtkTableToGraph_ClearLinkVertices_04 (HandleRef pThis)
static internal void vtkTableToGraph_DirectedOff_05 (HandleRef pThis)
static internal void vtkTableToGraph_DirectedOn_06 (HandleRef pThis)
static internal byte vtkTableToGraph_GetDirected_07 (HandleRef pThis)
static internal IntPtr vtkTableToGraph_GetLinkGraph_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal uint vtkTableToGraph_GetMTime_09 (HandleRef pThis)
static internal int vtkTableToGraph_IsA_10 (HandleRef pThis, string type)
static internal int vtkTableToGraph_IsTypeOf_11 (string type)
static internal void vtkTableToGraph_LinkColumnPath_12 (HandleRef pThis, HandleRef column, HandleRef domain, HandleRef hidden)
static internal IntPtr vtkTableToGraph_NewInstance_14 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkTableToGraph_SafeDownCast_15 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTableToGraph_SetDirected_16 (HandleRef pThis, byte _arg)
static internal void vtkTableToGraph_SetLinkGraph_17 (HandleRef pThis, HandleRef g)
static internal void vtkTableToGraph_SetVertexTableConnection_18 (HandleRef pThis, HandleRef arg0)

Static Private Member Functions

static vtkTableToGraph ()
 Automatically generated type registration mechanics.

Detailed Description

vtkTableToGraph - convert a vtkTable into a vtkGraph

Description vtkTableToGraph converts a table to a graph using an auxiliary link graph. The link graph specifies how each row in the table should be converted to an edge, or a collection of edges. It also specifies which columns of the table should be considered part of the same domain, and which columns should be hidden.

A second, optional, table may be provided as the vertex table. This vertex table must have one or more domain columns whose values match values in the edge table. The linked column name is specified in the domain array in the link graph. The output graph will only contain vertices corresponding to a row in the vertex table. For heterogenous graphs, you may want to use vtkMergeTables to create a single vertex table.

The link graph contains the following arrays:

(1) The "column" array has the names of the columns to connect in each table row. This array is required.

(2) The optional "domain" array provides user-defined domain names for each column. Matching domains in multiple columns will merge vertices with the same value from those columns. By default, all columns are in the same domain. If a vertex table is supplied, the domain indicates the column in the vertex table that the edge table column associates with. If the user provides a vertex table but no domain names, the output will be an empty graph. Hidden columns do not need valid domain names.

(3) The optional "hidden" array is a bit array specifying whether the column should be hidden. The resulting graph will contain edges representing connections "through" the hidden column, but the vertices for that column will not be present. By default, no columns are hidden. Hiding a column in a particular domain hides all columns in that domain.

The output graph will contain three additional arrays in the vertex data. The "domain" column is a string array containing the domain of each vertex. The "label" column is a string version of the distinct value that, along with the domain, defines that vertex. The "ids" column also contains the distinguishing value, but as a vtkVariant holding the raw value instead of being converted to a string. The "ids" column is set as the vertex pedigree ID attribute.


Constructor & Destructor Documentation

static Kitware.VTK.vtkTableToGraph.vtkTableToGraph ( ) [static, private]

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

void Kitware.VTK.vtkTableToGraph.AddLinkEdge ( string  column1,
string  column2 
)

Add an edge to the link graph. Specify the names of the columns to link.

void Kitware.VTK.vtkTableToGraph.AddLinkVertex ( string  column,
string  domain,
int  hidden 
)

Add a vertex to the link graph. Specify the column name, the domain name for the column, and whether the column is hidden.

Clear the link graph edges. The graph vertices will remain.

Clear the link graph vertices. This also clears all edges.

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

Specify the directedness of the output graph.

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

Specify the directedness of the output graph.

override void Kitware.VTK.vtkTableToGraph.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.

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

Specify the directedness of the output graph.

The graph describing how to link the columns in the table.

Here is the call graph for this function:

override uint Kitware.VTK.vtkTableToGraph.GetMTime ( ) [virtual]

Get the current modified time.

Reimplemented from Kitware.VTK.vtkObject.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkGraphAlgorithm.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkGraphAlgorithm.

Links the columns in a specific order. This creates a simple path as the link graph.

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.vtkTableToGraph.SetDirected ( bool  _arg) [virtual]

Specify the directedness of the output graph.

The graph describing how to link the columns in the table.

A convenience method for setting the vertex table input. This is mainly for the benefit of the VTK client/server layer, vanilla VTK code should use e.g:

table_to_graph->SetInputConnection(1, vertex_table->output());

static internal void Kitware.VTK.vtkTableToGraph.vtkTableToGraph_AddLinkEdge_01 ( HandleRef  pThis,
string  column1,
string  column2 
) [private]
static internal void Kitware.VTK.vtkTableToGraph.vtkTableToGraph_AddLinkVertex_02 ( HandleRef  pThis,
string  column,
string  domain,
int  hidden 
) [private]
static internal void Kitware.VTK.vtkTableToGraph.vtkTableToGraph_ClearLinkEdges_03 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkTableToGraph.vtkTableToGraph_ClearLinkVertices_04 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkTableToGraph.vtkTableToGraph_DirectedOff_05 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkTableToGraph.vtkTableToGraph_DirectedOn_06 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkTableToGraph.vtkTableToGraph_GetDirected_07 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkTableToGraph.vtkTableToGraph_GetLinkGraph_08 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal uint Kitware.VTK.vtkTableToGraph.vtkTableToGraph_GetMTime_09 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTableToGraph.vtkTableToGraph_IsA_10 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkTableToGraph.vtkTableToGraph_IsTypeOf_11 ( string  type) [private]
static internal void Kitware.VTK.vtkTableToGraph.vtkTableToGraph_LinkColumnPath_12 ( HandleRef  pThis,
HandleRef  column,
HandleRef  domain,
HandleRef  hidden 
) [private]
static internal IntPtr Kitware.VTK.vtkTableToGraph.vtkTableToGraph_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTableToGraph.vtkTableToGraph_NewInstance_14 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTableToGraph.vtkTableToGraph_SafeDownCast_15 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTableToGraph.vtkTableToGraph_SetDirected_16 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkTableToGraph.vtkTableToGraph_SetLinkGraph_17 ( HandleRef  pThis,
HandleRef  g 
) [private]
static internal void Kitware.VTK.vtkTableToGraph.vtkTableToGraph_SetVertexTableConnection_18 ( HandleRef  pThis,
HandleRef  arg0 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkTableToGraph.MRClassNameKey = "15vtkTableToGraph" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkGraphAlgorithm.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkGraphAlgorithm.


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