Kitware.VTK.vtkMySQLDatabase Class Reference

vtkMySQLDatabase - maintain a connection to a MySQL database More...

Inheritance diagram for Kitware.VTK.vtkMySQLDatabase:

Collaboration diagram for Kitware.VTK.vtkMySQLDatabase:

List of all members.

Public Member Functions
	vtkMySQLDatabase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkMySQLDatabase ()
	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	GetDatabaseName ()
	The name of the database to connect to.
override string	GetDatabaseType ()
	String representing database type (e.g. "mysql").
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.
virtual int	GetReconnect ()
	Should automatic reconnection be enabled? This defaults to true. If you change its value, you must do so before any call to Open().
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 vtkMySQLDatabase	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	ReconnectOff ()
	Should automatic reconnection be enabled? This defaults to true. If you change its value, you must do so before any call to Open().
virtual void	ReconnectOn ()
	Should automatic reconnection be enabled? This defaults to true. If you change its value, you must do so before any call to Open().
virtual void	SetDatabaseName (string _arg)
	The name of the database to connect to.
virtual void	SetHostName (string _arg)
	The database server host name.
virtual void	SetPassword (string _arg)
	The user's password for connecting to the database server.
virtual void	SetReconnect (int _arg)
	Should automatic reconnection be enabled? This defaults to true. If you change its value, you must do so before any call to Open().
virtual void	SetServerPort (int _arg)
	The port used for connecting to the database.
virtual void	SetUser (string _arg)
	The user name for connecting to the database server.
Static Public Member Functions
static new vtkMySQLDatabase	New ()
	Undocumented Block.
static new int	IsTypeOf (string type)
	Undocumented Block.
static new vtkMySQLDatabase	SafeDownCast (vtkObjectBase o)
	Undocumented Block.
Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkMySQLDatabase"
	Automatically generated type registration mechanics.
Static Public Attributes
static new readonly string	MRClassNameKey = "16vtkMySQLDatabase"
	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	vtkMySQLDatabase_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void	vtkMySQLDatabase_Close_01 (HandleRef pThis)
static internal byte	vtkMySQLDatabase_CreateDatabase_02 (HandleRef pThis, string dbName, byte dropExisting)
static internal byte	vtkMySQLDatabase_DropDatabase_03 (HandleRef pThis, string dbName)
static internal IntPtr	vtkMySQLDatabase_GetDatabaseName_04 (HandleRef pThis)
static internal IntPtr	vtkMySQLDatabase_GetDatabaseType_05 (HandleRef pThis)
static internal IntPtr	vtkMySQLDatabase_GetHostName_06 (HandleRef pThis)
static internal IntPtr	vtkMySQLDatabase_GetLastErrorText_07 (HandleRef pThis)
static internal IntPtr	vtkMySQLDatabase_GetQueryInstance_08 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int	vtkMySQLDatabase_GetReconnect_09 (HandleRef pThis)
static internal IntPtr	vtkMySQLDatabase_GetRecord_10 (HandleRef pThis, string table, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int	vtkMySQLDatabase_GetServerPort_11 (HandleRef pThis)
static internal int	vtkMySQLDatabase_GetServerPortMaxValue_12 (HandleRef pThis)
static internal int	vtkMySQLDatabase_GetServerPortMinValue_13 (HandleRef pThis)
static internal IntPtr	vtkMySQLDatabase_GetTables_14 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr	vtkMySQLDatabase_GetUser_15 (HandleRef pThis)
static internal byte	vtkMySQLDatabase_HasError_16 (HandleRef pThis)
static internal int	vtkMySQLDatabase_IsA_17 (HandleRef pThis, string type)
static internal byte	vtkMySQLDatabase_IsOpen_18 (HandleRef pThis)
static internal byte	vtkMySQLDatabase_IsSupported_19 (HandleRef pThis, int feature)
static internal int	vtkMySQLDatabase_IsTypeOf_20 (string type)
static internal IntPtr	vtkMySQLDatabase_NewInstance_22 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte	vtkMySQLDatabase_Open_23 (HandleRef pThis, string password)
static internal void	vtkMySQLDatabase_ReconnectOff_24 (HandleRef pThis)
static internal void	vtkMySQLDatabase_ReconnectOn_25 (HandleRef pThis)
static internal IntPtr	vtkMySQLDatabase_SafeDownCast_26 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void	vtkMySQLDatabase_SetDatabaseName_27 (HandleRef pThis, string _arg)
static internal void	vtkMySQLDatabase_SetHostName_28 (HandleRef pThis, string _arg)
static internal void	vtkMySQLDatabase_SetPassword_29 (HandleRef pThis, string _arg)
static internal void	vtkMySQLDatabase_SetReconnect_30 (HandleRef pThis, int _arg)
static internal void	vtkMySQLDatabase_SetServerPort_31 (HandleRef pThis, int _arg)
static internal void	vtkMySQLDatabase_SetUser_32 (HandleRef pThis, string _arg)
Static Private Member Functions
static	vtkMySQLDatabase ()
	Automatically generated type registration mechanics.

---

Detailed Description

vtkMySQLDatabase - maintain a connection to a MySQL database

Description

This class provides a VTK interface to MySQL (http://www.mysql.com). Unlike file-based databases like SQLite, you talk to MySQL through a client/server connection. You must specify the hostname, (optional) port to connect to, username, password and database name in order to connect.

vtkMySQLQuery

---

Constructor & Destructor Documentation

static Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase

(

)

[static, private]

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase

(

)

Undocumented Block.

---

Member Function Documentation

override void Kitware.VTK.vtkMySQLDatabase.Close

(

)

[virtual]

Close the connection to the database.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

bool Kitware.VTK.vtkMySQLDatabase.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.vtkMySQLDatabase.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.vtkMySQLDatabase.DropDatabase

(

string

dbName

)

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

virtual string Kitware.VTK.vtkMySQLDatabase.GetDatabaseName

(

)

[virtual]

The name of the database to connect to.

override string Kitware.VTK.vtkMySQLDatabase.GetDatabaseType

(

)

[virtual]

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

Reimplemented from Kitware.VTK.vtkSQLDatabase.

virtual string Kitware.VTK.vtkMySQLDatabase.GetHostName

(

)

[virtual]

The database server host name.

override string Kitware.VTK.vtkMySQLDatabase.GetLastErrorText

(

)

[virtual]

Get the last error text from the database.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

override vtkSQLQuery Kitware.VTK.vtkMySQLDatabase.GetQueryInstance

(

)

[virtual]

Return an empty query on this database.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

Here is the call graph for this function:

virtual int Kitware.VTK.vtkMySQLDatabase.GetReconnect

(

)

[virtual]

Should automatic reconnection be enabled? This defaults to true. If you change its value, you must do so before any call to Open().

override vtkStringArray Kitware.VTK.vtkMySQLDatabase.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.vtkMySQLDatabase.GetServerPort

(

)

[virtual]

The port used for connecting to the database.

virtual int Kitware.VTK.vtkMySQLDatabase.GetServerPortMaxValue

(

)

[virtual]

The port used for connecting to the database.

virtual int Kitware.VTK.vtkMySQLDatabase.GetServerPortMinValue

(

)

[virtual]

The port used for connecting to the database.

override vtkStringArray Kitware.VTK.vtkMySQLDatabase.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.vtkMySQLDatabase.GetUser

(

)

[virtual]

The user name for connecting to the database server.

override bool Kitware.VTK.vtkMySQLDatabase.HasError

(

)

[virtual]

Did the last operation generate an error.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

override int Kitware.VTK.vtkMySQLDatabase.IsA

(

string

type

)

[virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

override bool Kitware.VTK.vtkMySQLDatabase.IsOpen

(

)

[virtual]

Return whether the database has an open connection.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

override bool Kitware.VTK.vtkMySQLDatabase.IsSupported

(

int

feature

)

[virtual]

Return whether a feature is supported by the database.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

static new int Kitware.VTK.vtkMySQLDatabase.IsTypeOf

(

string

type

)

[static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

static new vtkMySQLDatabase Kitware.VTK.vtkMySQLDatabase.New

(

)

[static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

new vtkMySQLDatabase Kitware.VTK.vtkMySQLDatabase.NewInstance

(

)

Undocumented Block.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

override bool Kitware.VTK.vtkMySQLDatabase.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.

virtual void Kitware.VTK.vtkMySQLDatabase.ReconnectOff

(

)

[virtual]

Should automatic reconnection be enabled? This defaults to true. If you change its value, you must do so before any call to Open().

virtual void Kitware.VTK.vtkMySQLDatabase.ReconnectOn

(

)

[virtual]

Should automatic reconnection be enabled? This defaults to true. If you change its value, you must do so before any call to Open().

static new vtkMySQLDatabase Kitware.VTK.vtkMySQLDatabase.SafeDownCast

(

vtkObjectBase

o

)

[static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkMySQLDatabase.SetDatabaseName

(

string

_arg

)

[virtual]

The name of the database to connect to.

virtual void Kitware.VTK.vtkMySQLDatabase.SetHostName

(

string

_arg

)

[virtual]

The database server host name.

virtual void Kitware.VTK.vtkMySQLDatabase.SetPassword

(

string

_arg

)

[virtual]

The user's password for connecting to the database server.

virtual void Kitware.VTK.vtkMySQLDatabase.SetReconnect

(

int

_arg

)

[virtual]

Should automatic reconnection be enabled? This defaults to true. If you change its value, you must do so before any call to Open().

virtual void Kitware.VTK.vtkMySQLDatabase.SetServerPort

(

int

_arg

)

[virtual]

The port used for connecting to the database.

virtual void Kitware.VTK.vtkMySQLDatabase.SetUser

(

string

_arg

)

[virtual]

The user name for connecting to the database server.

static internal void Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_Close_01

(

HandleRef

pThis

)

[private]

static internal byte Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_CreateDatabase_02	(	HandleRef	pThis,
		string	dbName,
		byte	dropExisting
	)		[private]

static internal byte Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_DropDatabase_03	(	HandleRef	pThis,
		string	dbName
	)		[private]

static internal IntPtr Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_GetDatabaseName_04

(

HandleRef

pThis

)

[private]

static internal IntPtr Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_GetDatabaseType_05

(

HandleRef

pThis

)

[private]

static internal IntPtr Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_GetHostName_06

(

HandleRef

pThis

)

[private]

static internal IntPtr Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_GetLastErrorText_07

(

HandleRef

pThis

)

[private]

static internal IntPtr Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_GetQueryInstance_08	(	HandleRef	pThis,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal int Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_GetReconnect_09

(

HandleRef

pThis

)

[private]

static internal IntPtr Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_GetRecord_10	(	HandleRef	pThis,
		string	table,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal int Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_GetServerPort_11

(

HandleRef

pThis

)

[private]

static internal int Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_GetServerPortMaxValue_12

(

HandleRef

pThis

)

[private]

static internal int Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_GetServerPortMinValue_13

(

HandleRef

pThis

)

[private]

static internal IntPtr Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_GetTables_14	(	HandleRef	pThis,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal IntPtr Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_GetUser_15

(

HandleRef

pThis

)

[private]

static internal byte Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_HasError_16

(

HandleRef

pThis

)

[private]

static internal int Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_IsA_17	(	HandleRef	pThis,
		string	type
	)		[private]

static internal byte Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_IsOpen_18

(

HandleRef

pThis

)

[private]

static internal byte Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_IsSupported_19	(	HandleRef	pThis,
		int	feature
	)		[private]

static internal int Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_IsTypeOf_20

(

string

type

)

[private]

static internal IntPtr Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_New	(	ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal IntPtr Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_NewInstance_22	(	HandleRef	pThis,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal byte Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_Open_23	(	HandleRef	pThis,
		string	password
	)		[private]

static internal void Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_ReconnectOff_24

(

HandleRef

pThis

)

[private]

static internal void Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_ReconnectOn_25

(

HandleRef

pThis

)

[private]

static internal IntPtr Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_SafeDownCast_26	(	HandleRef	o,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		[private]

static internal void Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_SetDatabaseName_27	(	HandleRef	pThis,
		string	_arg
	)		[private]

static internal void Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_SetHostName_28	(	HandleRef	pThis,
		string	_arg
	)		[private]

static internal void Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_SetPassword_29	(	HandleRef	pThis,
		string	_arg
	)		[private]

static internal void Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_SetReconnect_30	(	HandleRef	pThis,
		int	_arg
	)		[private]

static internal void Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_SetServerPort_31	(	HandleRef	pThis,
		int	_arg
	)		[private]

static internal void Kitware.VTK.vtkMySQLDatabase.vtkMySQLDatabase_SetUser_32	(	HandleRef	pThis,
		string	_arg
	)		[private]

---

Member Data Documentation

new readonly string Kitware.VTK.vtkMySQLDatabase.MRClassNameKey = "16vtkMySQLDatabase" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkSQLDatabase.

---

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

• csharp/vtkMySQLDatabase.cs