VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSQLGraphReader Class Reference

read a vtkGraph from a database More...

#include <vtkSQLGraphReader.h>

Inheritance diagram for vtkSQLGraphReader:
[legend]
Collaboration diagram for vtkSQLGraphReader:
[legend]

Public Types

typedef vtkGraphAlgorithm Superclass
 
- Public Types inherited from vtkGraphAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetDirected (bool)
 
virtual bool GetDirected ()
 
virtual void DirectedOn ()
 
virtual void DirectedOff ()
 
virtual void SetVertexQuery (vtkSQLQuery *q)
 
virtual vtkSQLQueryGetVertexQuery ()
 
virtual void SetEdgeQuery (vtkSQLQuery *q)
 
virtual vtkSQLQueryGetEdgeQuery ()
 
virtual void SetSourceField (const char *)
 
virtual char * GetSourceField ()
 
virtual void SetTargetField (const char *)
 
virtual char * GetTargetField ()
 
virtual void SetVertexIdField (const char *)
 
virtual char * GetVertexIdField ()
 
virtual void SetXField (const char *)
 
virtual char * GetXField ()
 
virtual void SetYField (const char *)
 
virtual char * GetYField ()
 
virtual void SetZField (const char *)
 
virtual char * GetZField ()
 
virtual void SetCollapseEdges (bool)
 
virtual bool GetCollapseEdges ()
 
virtual void CollapseEdgesOn ()
 
virtual void CollapseEdgesOff ()
 
- Public Member Functions inherited from vtkGraphAlgorithm
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
vtkGraphGetOutput ()
 
vtkGraphGetOutput (int index)
 
void SetInput (vtkDataObject *obj)
 
void SetInput (int index, vtkDataObject *obj)
 
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformationGetInputPortInformation (int port)
 
vtkInformationGetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformationGetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
virtual void Update ()
 
virtual void UpdateInformation ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 
vtkDataObjectGetInputDataObject (int port, int connection)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkSQLGraphReaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSQLGraphReaderSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkGraphAlgorithm
static vtkGraphAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkGraphAlgorithmSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObject *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyPRESERVES_DATASET ()
 
static vtkInformationIntegerKeyPRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKeyPRESERVES_BOUNDS ()
 
static vtkInformationIntegerKeyPRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKeyPRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKeyPRESERVES_RANGES ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSQLGraphReader ()
 
 ~vtkSQLGraphReader ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkGraphAlgorithm
 vtkGraphAlgorithm ()
 
 ~vtkGraphAlgorithm ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm ()
 
virtual void SetNumberOfInputPorts (int n)
 
virtual void SetNumberOfOutputPorts (int n)
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 
virtual vtkExecutiveCreateDefaultExecutive ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void SetNumberOfInputConnections (int port, int n)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
virtual void SetErrorCode (unsigned long)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

bool Directed
 
bool CollapseEdges
 
vtkSQLQueryEdgeQuery
 
vtkSQLQueryVertexQuery
 
char * SourceField
 
char * TargetField
 
char * VertexIdField
 
char * XField
 
char * YField
 
char * ZField
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

read a vtkGraph from a database

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.

Tests:
vtkSQLGraphReader (Tests)

Definition at line 65 of file vtkSQLGraphReader.h.

Member Typedef Documentation

Definition at line 69 of file vtkSQLGraphReader.h.

Constructor & Destructor Documentation

vtkSQLGraphReader::vtkSQLGraphReader ( )
protected
vtkSQLGraphReader::~vtkSQLGraphReader ( )
protected

Member Function Documentation

static vtkSQLGraphReader* vtkSQLGraphReader::New ( )
static
virtual const char* vtkSQLGraphReader::GetClassName ( )
virtual

Reimplemented from vtkGraphAlgorithm.

static int vtkSQLGraphReader::IsTypeOf ( const char *  type)
static
virtual int vtkSQLGraphReader::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkGraphAlgorithm.

static vtkSQLGraphReader* vtkSQLGraphReader::SafeDownCast ( vtkObject o)
static
void vtkSQLGraphReader::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkGraphAlgorithm.

virtual void vtkSQLGraphReader::SetDirected ( bool  )
virtual

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

virtual bool vtkSQLGraphReader::GetDirected ( )
virtual

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

virtual void vtkSQLGraphReader::DirectedOn ( )
virtual

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

virtual void vtkSQLGraphReader::DirectedOff ( )
virtual

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

virtual void vtkSQLGraphReader::SetVertexQuery ( vtkSQLQuery q)
virtual

The query that retrieves the node information.

virtual vtkSQLQuery* vtkSQLGraphReader::GetVertexQuery ( )
virtual

The query that retrieves the node information.

virtual void vtkSQLGraphReader::SetEdgeQuery ( vtkSQLQuery q)
virtual

The query that retrieves the arc information.

virtual vtkSQLQuery* vtkSQLGraphReader::GetEdgeQuery ( )
virtual

The query that retrieves the arc information.

virtual void vtkSQLGraphReader::SetSourceField ( const char *  )
virtual

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

virtual char* vtkSQLGraphReader::GetSourceField ( )
virtual

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

virtual void vtkSQLGraphReader::SetTargetField ( const char *  )
virtual

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

virtual char* vtkSQLGraphReader::GetTargetField ( )
virtual

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

virtual void vtkSQLGraphReader::SetVertexIdField ( const char *  )
virtual

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

virtual char* vtkSQLGraphReader::GetVertexIdField ( )
virtual

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

virtual void vtkSQLGraphReader::SetXField ( const char *  )
virtual

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

virtual char* vtkSQLGraphReader::GetXField ( )
virtual

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

virtual void vtkSQLGraphReader::SetYField ( const char *  )
virtual

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

virtual char* vtkSQLGraphReader::GetYField ( )
virtual

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

virtual void vtkSQLGraphReader::SetZField ( const char *  )
virtual

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

virtual char* vtkSQLGraphReader::GetZField ( )
virtual

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

virtual void vtkSQLGraphReader::SetCollapseEdges ( bool  )
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 bool vtkSQLGraphReader::GetCollapseEdges ( )
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 vtkSQLGraphReader::CollapseEdgesOn ( )
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 vtkSQLGraphReader::CollapseEdgesOff ( )
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 int vtkSQLGraphReader::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkGraphAlgorithm.

virtual int vtkSQLGraphReader::RequestDataObject ( vtkInformation ,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

By default, creates the same output type as the input type.

Reimplemented from vtkGraphAlgorithm.

Member Data Documentation

bool vtkSQLGraphReader::Directed
protected

Definition at line 145 of file vtkSQLGraphReader.h.

bool vtkSQLGraphReader::CollapseEdges
protected

Definition at line 146 of file vtkSQLGraphReader.h.

vtkSQLQuery* vtkSQLGraphReader::EdgeQuery
protected

Definition at line 147 of file vtkSQLGraphReader.h.

vtkSQLQuery* vtkSQLGraphReader::VertexQuery
protected

Definition at line 148 of file vtkSQLGraphReader.h.

char* vtkSQLGraphReader::SourceField
protected

Definition at line 149 of file vtkSQLGraphReader.h.

char* vtkSQLGraphReader::TargetField
protected

Definition at line 150 of file vtkSQLGraphReader.h.

char* vtkSQLGraphReader::VertexIdField
protected

Definition at line 151 of file vtkSQLGraphReader.h.

char* vtkSQLGraphReader::XField
protected

Definition at line 152 of file vtkSQLGraphReader.h.

char* vtkSQLGraphReader::YField
protected

Definition at line 153 of file vtkSQLGraphReader.h.

char* vtkSQLGraphReader::ZField
protected

Definition at line 154 of file vtkSQLGraphReader.h.


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