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

vtkSQLiteDatabase - maintain a connection to an SQLite database More...

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

List of all members.

Public Types

enum  CREATE_WrapperEnum { CREATE = 3, CREATE_OR_CLEAR = 2, USE_EXISTING = 0, USE_EXISTING_OR_CREATE = 1 }
 Undocumented Block. More...

Public Member Functions

 vtkSQLiteDatabase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkSQLiteDatabase ()
 Undocumented Block.
override void Close ()
 Close the connection to the database.
virtual string GetDatabaseFileName ()
 String representing the database filename.
override string GetDatabaseType ()
 String representing database type (e.g. "sqlite").
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.
override vtkStringArray GetTables ()
 Get the list of tables from the database.
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 vtkSQLiteDatabase 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.
bool Open (string password, int mode)
 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 SetDatabaseFileName (string _arg)
 String representing the database filename.

Static Public Member Functions

static new vtkSQLiteDatabase New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkSQLiteDatabase SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "17vtkSQLiteDatabase"
 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 vtkSQLiteDatabase_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSQLiteDatabase_Close_01 (HandleRef pThis)
static internal IntPtr vtkSQLiteDatabase_GetDatabaseFileName_02 (HandleRef pThis)
static internal IntPtr vtkSQLiteDatabase_GetDatabaseType_03 (HandleRef pThis)
static internal IntPtr vtkSQLiteDatabase_GetLastErrorText_04 (HandleRef pThis)
static internal IntPtr vtkSQLiteDatabase_GetQueryInstance_05 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkSQLiteDatabase_GetRecord_06 (HandleRef pThis, string table, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkSQLiteDatabase_GetTables_07 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte vtkSQLiteDatabase_HasError_08 (HandleRef pThis)
static internal int vtkSQLiteDatabase_IsA_09 (HandleRef pThis, string type)
static internal byte vtkSQLiteDatabase_IsOpen_10 (HandleRef pThis)
static internal byte vtkSQLiteDatabase_IsSupported_11 (HandleRef pThis, int feature)
static internal int vtkSQLiteDatabase_IsTypeOf_12 (string type)
static internal IntPtr vtkSQLiteDatabase_NewInstance_14 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte vtkSQLiteDatabase_Open_15 (HandleRef pThis, string password)
static internal byte vtkSQLiteDatabase_Open_16 (HandleRef pThis, string password, int mode)
static internal IntPtr vtkSQLiteDatabase_SafeDownCast_17 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkSQLiteDatabase_SetDatabaseFileName_18 (HandleRef pThis, string _arg)

Static Private Member Functions

static vtkSQLiteDatabase ()
 Automatically generated type registration mechanics.

Detailed Description

vtkSQLiteDatabase - maintain a connection to an SQLite database

Description

SQLite (http://www.sqlite.org) is a public-domain SQL database written in C++. It's small, fast, and can be easily embedded inside other applications. Its databases are stored in files.

This class provides a VTK interface to SQLite. You do not need to download any external libraries: we include a copy of SQLite 3.3.16 in VTK/Utilities/vtksqlite.

If you want to open a database that stays in memory and never gets written to disk, pass in the URL 'sqlite://:memory:'; otherwise, specifiy the file path by passing the URL 'sqlite://<file_path>'.

Thanks Thanks to Andrew Wilson and Philippe Pebay from Sandia National Laboratories for implementing this class.

vtkSQLiteQuery


Member Enumeration Documentation

Undocumented Block.

Enumerator:
CREATE 

enum member

CREATE_OR_CLEAR 

enum member

USE_EXISTING 

enum member

USE_EXISTING_OR_CREATE 

enum member


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase ( 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.vtkSQLiteDatabase.Close ( ) [virtual]

Close the connection to the database.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

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

String representing the database filename.

override string Kitware.VTK.vtkSQLiteDatabase.GetDatabaseType ( ) [virtual]

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

Reimplemented from Kitware.VTK.vtkSQLDatabase.

override string Kitware.VTK.vtkSQLiteDatabase.GetLastErrorText ( ) [virtual]

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

Get the list of tables from the database.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

Here is the call graph for this function:

override bool Kitware.VTK.vtkSQLiteDatabase.HasError ( ) [virtual]

Did the last operation generate an error.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

override int Kitware.VTK.vtkSQLiteDatabase.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

override bool Kitware.VTK.vtkSQLiteDatabase.IsOpen ( ) [virtual]

Return whether the database has an open connection.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

override bool Kitware.VTK.vtkSQLiteDatabase.IsSupported ( int  feature) [virtual]

Return whether a feature is supported by the database.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

static new int Kitware.VTK.vtkSQLiteDatabase.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.vtkSQLiteDatabase.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.

  • USE_EXISTING (default) - Fail if the file does not exist.
  • USE_EXISTING_OR_CREATE - Create a new file if necessary.
  • CREATE_OR_CLEAR - Create new or clear existing file.
  • CREATE - Create new, fail if file exists.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

bool Kitware.VTK.vtkSQLiteDatabase.Open ( string  password,
int  mode 
)

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.

  • USE_EXISTING (default) - Fail if the file does not exist.
  • USE_EXISTING_OR_CREATE - Create a new file if necessary.
  • CREATE_OR_CLEAR - Create new or clear existing file.
  • CREATE - Create new, fail if file exists.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkSQLiteDatabase.SetDatabaseFileName ( string  _arg) [virtual]

String representing the database filename.

static internal void Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_Close_01 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_GetDatabaseFileName_02 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_GetDatabaseType_03 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_GetLastErrorText_04 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_GetQueryInstance_05 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_GetRecord_06 ( HandleRef  pThis,
string  table,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_GetTables_07 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal byte Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_HasError_08 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_IsA_09 ( HandleRef  pThis,
string  type 
) [private]
static internal byte Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_IsOpen_10 ( HandleRef  pThis) [private]
static internal byte Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_IsSupported_11 ( HandleRef  pThis,
int  feature 
) [private]
static internal int Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_IsTypeOf_12 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_NewInstance_14 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal byte Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_Open_15 ( HandleRef  pThis,
string  password 
) [private]
static internal byte Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_Open_16 ( HandleRef  pThis,
string  password,
int  mode 
) [private]
static internal IntPtr Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_SafeDownCast_17 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkSQLiteDatabase.vtkSQLiteDatabase_SetDatabaseFileName_18 ( HandleRef  pThis,
string  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkSQLiteDatabase.MRClassNameKey = "17vtkSQLiteDatabase" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkSQLDatabase.


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