VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkSQLDatabaseGraphSource Class Reference

Generates a vtkGraph based on an SQL query. More...

#include <vtkSQLDatabaseGraphSource.h>

Inheritance diagram for vtkSQLDatabaseGraphSource:
Inheritance graph
[legend]
Collaboration diagram for vtkSQLDatabaseGraphSource:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkGraphAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkSQLDatabaseGraphSourceNewInstance () const
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 (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkSQLDatabaseGraphSource ()
 ~vtkSQLDatabaseGraphSource ()
int RequestDataObject (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

bool GenerateEdgePedigreeIds
char * EdgePedigreeIdArrayName

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 41 of file vtkSQLDatabaseGraphSource.h.


Member Typedef Documentation

Reimplemented from vtkGraphAlgorithm.

Definition at line 45 of file vtkSQLDatabaseGraphSource.h.


Constructor & Destructor Documentation


Member Function Documentation

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

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.

Reimplemented from vtkGraphAlgorithm.

virtual vtkObjectBase* vtkSQLDatabaseGraphSource::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkGraphAlgorithm.

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.

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

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.

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

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.

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.

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 100 of file vtkSQLDatabaseGraphSource.h.

Definition at line 101 of file vtkSQLDatabaseGraphSource.h.


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