vtkSQLDatabaseGraphSource Class Reference

#include <vtkSQLDatabaseGraphSource.h>

Inheritance diagram for vtkSQLDatabaseGraphSource:

Inheritance graph
[legend]
Collaboration diagram for vtkSQLDatabaseGraphSource:

Collaboration graph
[legend]

List of all members.


Detailed Description

Generates a vtkGraph based on an SQL query.

This class combines vtkSQLDatabase, vtkSQLQuery, and vtkQueryToGraph to provide a convenience class for generating graphs from databases. Also this class can be easily wrapped and used within ParaView / OverView.

Examples:
vtkSQLDatabaseGraphSource (Examples)

Definition at line 40 of file vtkSQLDatabaseGraphSource.h.


Public Types

typedef vtkGraphAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
vtkStdString GetURL ()
void SetURL (const vtkStdString &url)
void SetPassword (const vtkStdString &password)
vtkStdString GetEdgeQuery ()
void SetEdgeQuery (const vtkStdString &query)
vtkStdString GetVertexQuery ()
void SetVertexQuery (const vtkStdString &query)
void AddLinkVertex (const char *column, const char *domain=0, int hidden=0)
void ClearLinkVertices ()
void AddLinkEdge (const char *column1, const char *column2)
void ClearLinkEdges ()
virtual bool GetGenerateEdgePedigreeIds ()
virtual void SetGenerateEdgePedigreeIds (bool)
virtual void GenerateEdgePedigreeIdsOn ()
virtual void GenerateEdgePedigreeIdsOff ()
virtual void SetEdgePedigreeIdArrayName (const char *)
virtual char * GetEdgePedigreeIdArrayName ()
virtual void SetDirected (bool)
virtual bool GetDirected ()
virtual void DirectedOn ()
virtual void DirectedOff ()

Static Public Member Functions

static vtkSQLDatabaseGraphSourceNew ()
static int IsTypeOf (const char *type)
static vtkSQLDatabaseGraphSourceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkSQLDatabaseGraphSource ()
 ~vtkSQLDatabaseGraphSource ()
int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

bool GenerateEdgePedigreeIds
char * EdgePedigreeIdArrayName

Member Typedef Documentation

Reimplemented from vtkGraphAlgorithm.

Definition at line 44 of file vtkSQLDatabaseGraphSource.h.


Constructor & Destructor Documentation

vtkSQLDatabaseGraphSource::vtkSQLDatabaseGraphSource (  )  [protected]

vtkSQLDatabaseGraphSource::~vtkSQLDatabaseGraphSource (  )  [protected]


Member Function Documentation

static vtkSQLDatabaseGraphSource* vtkSQLDatabaseGraphSource::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkGraphAlgorithm.

virtual const char* vtkSQLDatabaseGraphSource::GetClassName (  )  [virtual]

Reimplemented from vtkGraphAlgorithm.

static int vtkSQLDatabaseGraphSource::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type 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.

virtual int vtkSQLDatabaseGraphSource::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 vtkSQLDatabaseGraphSource* vtkSQLDatabaseGraphSource::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkGraphAlgorithm.

void vtkSQLDatabaseGraphSource::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.

vtkStdString vtkSQLDatabaseGraphSource::GetURL (  ) 

void vtkSQLDatabaseGraphSource::SetURL ( const vtkStdString url  ) 

void vtkSQLDatabaseGraphSource::SetPassword ( const vtkStdString password  ) 

vtkStdString vtkSQLDatabaseGraphSource::GetEdgeQuery (  ) 

void vtkSQLDatabaseGraphSource::SetEdgeQuery ( const vtkStdString query  ) 

vtkStdString vtkSQLDatabaseGraphSource::GetVertexQuery (  ) 

void vtkSQLDatabaseGraphSource::SetVertexQuery ( const vtkStdString query  ) 

void vtkSQLDatabaseGraphSource::AddLinkVertex ( const char *  column,
const char *  domain = 0,
int  hidden = 0 
)

void vtkSQLDatabaseGraphSource::ClearLinkVertices (  ) 

void vtkSQLDatabaseGraphSource::AddLinkEdge ( const char *  column1,
const char *  column2 
)

void vtkSQLDatabaseGraphSource::ClearLinkEdges (  ) 

virtual bool vtkSQLDatabaseGraphSource::GetGenerateEdgePedigreeIds (  )  [virtual]

If on (default), generate edge pedigree ids. If off, assign an array to be edge pedigree ids.

virtual void vtkSQLDatabaseGraphSource::SetGenerateEdgePedigreeIds ( bool   )  [virtual]

If on (default), generate edge pedigree ids. If off, assign an array to be edge pedigree ids.

virtual void vtkSQLDatabaseGraphSource::GenerateEdgePedigreeIdsOn (  )  [virtual]

If on (default), generate edge pedigree ids. If off, assign an array to be edge pedigree ids.

virtual void vtkSQLDatabaseGraphSource::GenerateEdgePedigreeIdsOff (  )  [virtual]

If on (default), generate edge pedigree ids. If off, assign an array to be edge pedigree ids.

virtual void vtkSQLDatabaseGraphSource::SetEdgePedigreeIdArrayName ( const char *   )  [virtual]

Use this array name for setting or generating edge pedigree ids.

virtual char* vtkSQLDatabaseGraphSource::GetEdgePedigreeIdArrayName (  )  [virtual]

Use this array name for setting or generating edge pedigree ids.

virtual void vtkSQLDatabaseGraphSource::SetDirected ( bool   )  [virtual]

If on (default), generate a directed output graph. If off, generate an undirected output graph.

virtual bool vtkSQLDatabaseGraphSource::GetDirected (  )  [virtual]

If on (default), generate a directed output graph. If off, generate an undirected output graph.

virtual void vtkSQLDatabaseGraphSource::DirectedOn (  )  [virtual]

If on (default), generate a directed output graph. If off, generate an undirected output graph.

virtual void vtkSQLDatabaseGraphSource::DirectedOff (  )  [virtual]

If on (default), generate a directed output graph. If off, generate an undirected output graph.

int vtkSQLDatabaseGraphSource::RequestDataObject ( vtkInformation ,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

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

Reimplemented from vtkGraphAlgorithm.

int vtkSQLDatabaseGraphSource::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

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

Reimplemented from vtkGraphAlgorithm.


Member Data Documentation

Definition at line 99 of file vtkSQLDatabaseGraphSource.h.

Definition at line 100 of file vtkSQLDatabaseGraphSource.h.


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

Generated on Mon Sep 27 18:51:54 2010 for VTK by  doxygen 1.5.6