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.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.

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.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "21vtkPostgreSQLDatabase"
 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 vtkPostgreSQLDatabase_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPostgreSQLDatabase_Close_01 (HandleRef pThis)
static internal byte vtkPostgreSQLDatabase_CreateDatabase_02 (HandleRef pThis, string dbName, byte dropExisting)
static internal byte vtkPostgreSQLDatabase_DropDatabase_03 (HandleRef pThis, string dbName)
static internal IntPtr vtkPostgreSQLDatabase_GetConnectOptions_04 (HandleRef pThis)
static internal IntPtr vtkPostgreSQLDatabase_GetDatabaseName_05 (HandleRef pThis)
static internal IntPtr vtkPostgreSQLDatabase_GetDatabaseType_06 (HandleRef pThis)
static internal IntPtr vtkPostgreSQLDatabase_GetDatabases_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkPostgreSQLDatabase_GetHostName_08 (HandleRef pThis)
static internal IntPtr vtkPostgreSQLDatabase_GetLastErrorText_09 (HandleRef pThis)
static internal IntPtr vtkPostgreSQLDatabase_GetQueryInstance_10 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkPostgreSQLDatabase_GetRecord_11 (HandleRef pThis, string table, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkPostgreSQLDatabase_GetServerPort_12 (HandleRef pThis)
static internal int vtkPostgreSQLDatabase_GetServerPortMaxValue_13 (HandleRef pThis)
static internal int vtkPostgreSQLDatabase_GetServerPortMinValue_14 (HandleRef pThis)
static internal IntPtr vtkPostgreSQLDatabase_GetTables_15 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkPostgreSQLDatabase_GetUser_16 (HandleRef pThis)
static internal byte vtkPostgreSQLDatabase_HasError_17 (HandleRef pThis)
static internal int vtkPostgreSQLDatabase_IsA_18 (HandleRef pThis, string type)
static internal byte vtkPostgreSQLDatabase_IsOpen_19 (HandleRef pThis)
static internal byte vtkPostgreSQLDatabase_IsSupported_20 (HandleRef pThis, int feature)
static internal int vtkPostgreSQLDatabase_IsTypeOf_21 (string type)
static internal IntPtr vtkPostgreSQLDatabase_NewInstance_23 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte vtkPostgreSQLDatabase_Open_24 (HandleRef pThis, string password)
static internal IntPtr vtkPostgreSQLDatabase_SafeDownCast_25 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkPostgreSQLDatabase_SetConnectOptions_26 (HandleRef pThis, string _arg)
static internal void vtkPostgreSQLDatabase_SetDatabaseName_27 (HandleRef pThis, string _arg)
static internal void vtkPostgreSQLDatabase_SetHostName_28 (HandleRef pThis, string _arg)
static internal void vtkPostgreSQLDatabase_SetPassword_29 (HandleRef pThis, string _arg)
static internal void vtkPostgreSQLDatabase_SetServerPort_30 (HandleRef pThis, int _arg)
static internal void vtkPostgreSQLDatabase_SetUser_31 (HandleRef pThis, string _arg)

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

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.

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.

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

Additional options for the database.

The name of the database to connect to.

Return a list of databases on the server.

Here is the call graph for this function:

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

Reimplemented from Kitware.VTK.vtkSQLDatabase.

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

The database server host name.

Get the last error text from the database.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

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:

The port used for connecting to the database.

The port used for connecting to the database.

The port used for connecting to the database.

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.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

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.

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.

static internal void Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_Close_01 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_CreateDatabase_02 ( HandleRef  pThis,
string  dbName,
byte  dropExisting 
) [private]
static internal byte Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_DropDatabase_03 ( HandleRef  pThis,
string  dbName 
) [private]
static internal IntPtr Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_GetConnectOptions_04 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_GetDatabaseName_05 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_GetDatabases_07 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_GetDatabaseType_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_GetHostName_08 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_GetLastErrorText_09 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_GetQueryInstance_10 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_GetRecord_11 ( HandleRef  pThis,
string  table,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_GetServerPort_12 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_GetTables_15 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_GetUser_16 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_HasError_17 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_IsA_18 ( HandleRef  pThis,
string  type 
) [private]
static internal byte Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_IsOpen_19 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_IsSupported_20 ( HandleRef  pThis,
int  feature 
) [private]
static internal int Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_IsTypeOf_21 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_NewInstance_23 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal byte Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_Open_24 ( HandleRef  pThis,
string  password 
) [private]
static internal IntPtr Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_SafeDownCast_25 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_SetConnectOptions_26 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_SetDatabaseName_27 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_SetHostName_28 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_SetPassword_29 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_SetServerPort_30 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkPostgreSQLDatabase.vtkPostgreSQLDatabase_SetUser_31 ( HandleRef  pThis,
string  _arg 
) [private]

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: