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

vtkPostgreSQLDatabase - maintain a connection to a PostgreSQL database More...

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

List of all members.

Public Member Functions

 vtkPostgreSQLDatabase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkPostgreSQLDatabase ()
 *Undocumented Block
override void Close ()
 Close the connection to the database.
bool CreateDatabase (string dbName, bool dropExisting)
 Create a new database, optionally dropping any existing database of the same name. Returns true when the database is properly created and false on failure.
bool DropDatabase (string dbName)
 Drop a database if it exists. Returns true on success and false on failure.
virtual string GetConnectOptions ()
 Additional options for the database.
virtual string GetDatabaseName ()
 The name of the database to connect to.
override string GetDatabaseType ()
 String representing database type (e.g. "psql").
vtkStringArray GetDatabases ()
 Return a list of databases on the server.
virtual string GetHostName ()
 The database server host name.
override string GetLastErrorText ()
 Get the last error text from the database.
override vtkSQLQuery GetQueryInstance ()
 Return an empty query on this database.
override vtkStringArray GetRecord (string table)
 Get the list of fields for a particular table.
virtual int GetServerPort ()
 The port used for connecting to the database.
virtual int GetServerPortMaxValue ()
 The port used for connecting to the database.
virtual int GetServerPortMinValue ()
 The port used for connecting to the database.
override vtkStringArray GetTables ()
 Get the list of tables from the database.
virtual string GetUser ()
 The user name for connecting to the database server.
override bool HasError ()
 Did the last operation generate an error.
override int IsA (string type)
 *Undocumented Block
override bool IsOpen ()
 Return whether the database has an open connection.
override bool IsSupported (int feature)
 Return whether a feature is supported by the database.
new vtkPostgreSQLDatabase NewInstance ()
 *Undocumented Block
override bool Open (string password)
 Open a new connection to the database. You need to set the filename before calling this function. Returns true if the database was opened successfully; false otherwise.
virtual void SetConnectOptions (string _arg)
 This is basically the body of the SetStringMacro but with a call to update an additional vtkTimeStamp. We inline the implementation so that wrapping will work.
virtual void SetDatabaseName (string _arg)
 This is basically the body of the SetStringMacro but with a call to update an additional vtkTimeStamp. We inline the implementation so that wrapping will work.
virtual void SetHostName (string _arg)
 This is basically the body of the SetStringMacro but with a call to update an additional vtkTimeStamp. We inline the implementation so that wrapping will work.
virtual void SetPassword (string _arg)
 This is basically the body of the SetStringMacro but with a call to update an additional vtkTimeStamp. We inline the implementation so that wrapping will work.
virtual void SetServerPort (int _arg)
 This is basically the body of the SetStringMacro but with a call to update an additional vtkTimeStamp. We inline the implementation so that wrapping will work.
virtual void SetUser (string _arg)
 This is basically the body of the SetStringMacro but with a call to update an additional vtkTimeStamp. We inline the implementation so that wrapping will work.
- Public Member Functions inherited from Kitware.VTK.vtkSQLDatabase
 vtkSQLDatabase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
delegate IntPtr CreateFunction (string arg0)
 Effect a database schema.
virtual bool EffectSchema (vtkSQLDatabaseSchema arg0, bool dropIfExists)
 Effect a database schema.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
virtual uint GetMTime ()
 Return this object's modified time.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object).
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static new vtkPostgreSQLDatabase New ()
 *Undocumented Block
static new int IsTypeOf (string type)
 *Undocumented Block
static new vtkPostgreSQLDatabase SafeDownCast (vtkObjectBase o)
 *Undocumented Block
- Static Public Member Functions inherited from Kitware.VTK.vtkSQLDatabase
static vtkSQLDatabase CreateFromURL (string URL)
 Create a the proper subclass given a URL. The URL format for SQL databases is a true URL of the form: 'protocol://'[[username[':'password]'']hostname[':'port]]'/'[dbname] .
static vtkInformationObjectBaseKey DATABASE ()
 Stores the database class pointer as an information key. This is currently used to store database pointers as part of 'data on demand' data objects. For example: The application may have a table/tree/whatever of documents, the data structure is storing the meta-data but not the full text. Further down the pipeline algorithms or views may want to retrieve additional information (full text)for specific documents.
static void RegisterCreateFromURLCallback (CreateFunction callback)
 Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols. The registered callbacks are tried in the order they are registered.
static void UnRegisterAllCreateFromURLCallbacks ()
 Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols. The registered callbacks are tried in the order they are registered.
static void UnRegisterCreateFromURLCallback (CreateFunction callback)
 Provides mechanism to register/unregister additional callbacks to create concrete subclasses of vtkSQLDatabase to handle different protocols. The registered callbacks are tried in the order they are registered.
- Static Public Member Functions inherited from Kitware.VTK.vtkObject
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. It allows the debugger to break on error.
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkPostgreSQLDatabase"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkSQLDatabase
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "21vtkPostgreSQLDatabase"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkSQLDatabase
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

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.

Static Private Member Functions

static vtkPostgreSQLDatabase ()
 Automatically generated type registration mechanics.

Detailed Description

vtkPostgreSQLDatabase - maintain a connection to a PostgreSQL database

Description

PostgreSQL (http://www.postgres.org) is a BSD-licensed SQL database. It's large, fast, and can not be easily embedded inside other applications. Its databases are stored in files that belong to another process.

This class provides a VTK interface to PostgreSQL. You do need to download external libraries: we need a copy of PostgreSQL 8 (currently 8.2 or 8.3) so that we can link against the libpq C interface.

Thanks

Thanks to David Thompson and Andy Wilson from Sandia National Laboratories for implementing this class.

vtkPostgreSQLQuery


Constructor & Destructor Documentation

static Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase ( )
staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase ( )

*Undocumented Block


Member Function Documentation

override void Kitware.VTK.vtkPostgreSQLDatabase.Close ( )
virtual

Close the connection to the database.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

bool Kitware.VTK.vtkPostgreSQLDatabase.CreateDatabase ( string  dbName,
bool  dropExisting 
)

Create a new database, optionally dropping any existing database of the same name. Returns true when the database is properly created and false on failure.

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

bool Kitware.VTK.vtkPostgreSQLDatabase.DropDatabase ( string  dbName)

Drop a database if it exists. Returns true on success and false on failure.

virtual string Kitware.VTK.vtkPostgreSQLDatabase.GetConnectOptions ( )
virtual

Additional options for the database.

virtual string Kitware.VTK.vtkPostgreSQLDatabase.GetDatabaseName ( )
virtual

The name of the database to connect to.

vtkStringArray Kitware.VTK.vtkPostgreSQLDatabase.GetDatabases ( )

Return a list of databases on the server.

Here is the call graph for this function:

override string Kitware.VTK.vtkPostgreSQLDatabase.GetDatabaseType ( )
virtual

String representing database type (e.g. "psql").

Reimplemented from Kitware.VTK.vtkSQLDatabase.

virtual string Kitware.VTK.vtkPostgreSQLDatabase.GetHostName ( )
virtual

The database server host name.

override string Kitware.VTK.vtkPostgreSQLDatabase.GetLastErrorText ( )
virtual

Get the last error text from the database.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

override vtkSQLQuery Kitware.VTK.vtkPostgreSQLDatabase.GetQueryInstance ( )
virtual

Return an empty query on this database.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

Here is the call graph for this function:

override vtkStringArray Kitware.VTK.vtkPostgreSQLDatabase.GetRecord ( string  table)
virtual

Get the list of fields for a particular table.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkPostgreSQLDatabase.GetServerPort ( )
virtual

The port used for connecting to the database.

virtual int Kitware.VTK.vtkPostgreSQLDatabase.GetServerPortMaxValue ( )
virtual

The port used for connecting to the database.

virtual int Kitware.VTK.vtkPostgreSQLDatabase.GetServerPortMinValue ( )
virtual

The port used for connecting to the database.

override vtkStringArray Kitware.VTK.vtkPostgreSQLDatabase.GetTables ( )
virtual

Get the list of tables from the database.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

Here is the call graph for this function:

virtual string Kitware.VTK.vtkPostgreSQLDatabase.GetUser ( )
virtual

The user name for connecting to the database server.

override bool Kitware.VTK.vtkPostgreSQLDatabase.HasError ( )
virtual

Did the last operation generate an error.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

override int Kitware.VTK.vtkPostgreSQLDatabase.IsA ( string  type)
virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkSQLDatabase.

override bool Kitware.VTK.vtkPostgreSQLDatabase.IsOpen ( )
virtual

Return whether the database has an open connection.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

override bool Kitware.VTK.vtkPostgreSQLDatabase.IsSupported ( int  feature)
virtual

Return whether a feature is supported by the database.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

static new int Kitware.VTK.vtkPostgreSQLDatabase.IsTypeOf ( string  type)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkSQLDatabase.

static new vtkPostgreSQLDatabase Kitware.VTK.vtkPostgreSQLDatabase.New ( )
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

new vtkPostgreSQLDatabase Kitware.VTK.vtkPostgreSQLDatabase.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkSQLDatabase.

override bool Kitware.VTK.vtkPostgreSQLDatabase.Open ( string  password)
virtual

Open a new connection to the database. You need to set the filename before calling this function. Returns true if the database was opened successfully; false otherwise.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

static new vtkPostgreSQLDatabase Kitware.VTK.vtkPostgreSQLDatabase.SafeDownCast ( vtkObjectBase  o)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkSQLDatabase.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkPostgreSQLDatabase.SetConnectOptions ( string  _arg)
virtual

This is basically the body of the SetStringMacro but with a call to update an additional vtkTimeStamp. We inline the implementation so that wrapping will work.

virtual void Kitware.VTK.vtkPostgreSQLDatabase.SetDatabaseName ( string  _arg)
virtual

This is basically the body of the SetStringMacro but with a call to update an additional vtkTimeStamp. We inline the implementation so that wrapping will work.

virtual void Kitware.VTK.vtkPostgreSQLDatabase.SetHostName ( string  _arg)
virtual

This is basically the body of the SetStringMacro but with a call to update an additional vtkTimeStamp. We inline the implementation so that wrapping will work.

virtual void Kitware.VTK.vtkPostgreSQLDatabase.SetPassword ( string  _arg)
virtual

This is basically the body of the SetStringMacro but with a call to update an additional vtkTimeStamp. We inline the implementation so that wrapping will work.

virtual void Kitware.VTK.vtkPostgreSQLDatabase.SetServerPort ( int  _arg)
virtual

This is basically the body of the SetStringMacro but with a call to update an additional vtkTimeStamp. We inline the implementation so that wrapping will work.

virtual void Kitware.VTK.vtkPostgreSQLDatabase.SetUser ( string  _arg)
virtual

This is basically the body of the SetStringMacro but with a call to update an additional vtkTimeStamp. We inline the implementation so that wrapping will work.


Member Data Documentation

new readonly string Kitware.VTK.vtkPostgreSQLDatabase.MRClassNameKey = "21vtkPostgreSQLDatabase"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkSQLDatabase.


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