vtkRowQuery - abstract interface for queries that return row-oriented results. More...

Inheritance diagram for Kitware.VTK.vtkRowQuery:

Collaboration diagram for Kitware.VTK.vtkRowQuery:

Public Member Functions
	vtkRowQuery (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
virtual void	CaseSensitiveFieldNamesOff ()
	Many databases do not preserve case in field names. This can cause GetFieldIndex to fail if you search for a field named someFieldName when the database actually stores it as SOMEFIELDNAME. This ivar controls whether GetFieldIndex() expects field names to be case-sensitive. The default is OFF, i.e. case is not preserved.
virtual void	CaseSensitiveFieldNamesOn ()
	Many databases do not preserve case in field names. This can cause GetFieldIndex to fail if you search for a field named someFieldName when the database actually stores it as SOMEFIELDNAME. This ivar controls whether GetFieldIndex() expects field names to be case-sensitive. The default is OFF, i.e. case is not preserved.
virtual bool	Execute ()
	Execute the query. This must be performed before any field name or data access functions are used.
virtual bool	GetCaseSensitiveFieldNames ()
	Many databases do not preserve case in field names. This can cause GetFieldIndex to fail if you search for a field named someFieldName when the database actually stores it as SOMEFIELDNAME. This ivar controls whether GetFieldIndex() expects field names to be case-sensitive. The default is OFF, i.e. case is not preserved.
int	GetFieldIndex (string name)
	Return the index of the specified query field. Uses GetNumberOfFields() and GetFieldName() to match field name.
virtual string	GetFieldName (int i)
	Return the name of the specified query field.
virtual int	GetFieldType (int i)
	Return the type of the field, using the constants defined in vtkType.h.
virtual string	GetLastErrorText ()
	Get the last error text from the query.
virtual int	GetNumberOfFields ()
	The number of fields in the query result.
virtual bool	HasError ()
	Returns true if an error is set, otherwise false.
override int	IsA (string type)
	Undocumented Block.
virtual bool	IsActive ()
	Return true if the query is active (i.e. execution was successful and results are ready to be fetched). Returns false on error or inactive query.
new vtkRowQuery	NewInstance ()
	Undocumented Block.
virtual bool	NextRow ()
	Advance row, return false if past end.
bool	NextRow (vtkVariantArray rowArray)
	Advance row, return false if past end. Also, fill array with row values.
virtual void	SetCaseSensitiveFieldNames (bool _arg)
	Many databases do not preserve case in field names. This can cause GetFieldIndex to fail if you search for a field named someFieldName when the database actually stores it as SOMEFIELDNAME. This ivar controls whether GetFieldIndex() expects field names to be case-sensitive. The default is OFF, i.e. case is not preserved.
Static Public Member Functions
static new int	IsTypeOf (string type)
	Undocumented Block.
static new vtkRowQuery	SafeDownCast (vtkObjectBase o)
	Undocumented Block.
Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkRowQuery"
	Automatically generated type registration mechanics.
Static Public Attributes
static new readonly string	MRClassNameKey = "11vtkRowQuery"
	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 void	vtkRowQuery_CaseSensitiveFieldNamesOff_01 (HandleRef pThis)
static internal void	vtkRowQuery_CaseSensitiveFieldNamesOn_02 (HandleRef pThis)
static internal byte	vtkRowQuery_Execute_03 (HandleRef pThis)
static internal byte	vtkRowQuery_GetCaseSensitiveFieldNames_04 (HandleRef pThis)
static internal int	vtkRowQuery_GetFieldIndex_05 (HandleRef pThis, string name)
static internal IntPtr	vtkRowQuery_GetFieldName_06 (HandleRef pThis, int i)
static internal int	vtkRowQuery_GetFieldType_07 (HandleRef pThis, int i)
static internal IntPtr	vtkRowQuery_GetLastErrorText_08 (HandleRef pThis)
static internal int	vtkRowQuery_GetNumberOfFields_09 (HandleRef pThis)
static internal byte	vtkRowQuery_HasError_10 (HandleRef pThis)
static internal int	vtkRowQuery_IsA_11 (HandleRef pThis, string type)
static internal byte	vtkRowQuery_IsActive_12 (HandleRef pThis)
static internal int	vtkRowQuery_IsTypeOf_13 (string type)
static internal IntPtr	vtkRowQuery_NewInstance_14 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal byte	vtkRowQuery_NextRow_15 (HandleRef pThis)
static internal byte	vtkRowQuery_NextRow_16 (HandleRef pThis, HandleRef rowArray)
static internal IntPtr	vtkRowQuery_SafeDownCast_17 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void	vtkRowQuery_SetCaseSensitiveFieldNames_18 (HandleRef pThis, byte _arg)
Static Private Member Functions
static	vtkRowQuery ()
	Automatically generated type registration mechanics.

Detailed Description

vtkRowQuery - abstract interface for queries that return row-oriented results.

Description The abstract superclass of query classes that return row-oriented (table) results. A subclass will provide database-specific query parameters and implement the vtkRowQuery API to return query results:

Execute() - Execute the query. No results need to be retrieved at this point, unless you are performing caching.

GetNumberOfFields() - After Execute() is performed, returns the number of fields in the query results.

GetFieldName() - The name of the field at an index.

GetFieldType() - The data type of the field at an index.

NextRow() - Advances the query results by one row, and returns whether there are more rows left in the query.

DataValue() - Extract a single data value from the current row.

Thanks Thanks to Andrew Wilson from Sandia National Laboratories for his work on the database classes.

vtkRowQueryToTable

Constructor & Destructor Documentation

static Kitware.VTK.vtkRowQuery.vtkRowQuery ( ) [static, private]

Automatically generated type registration mechanics.

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

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

Member Function Documentation

virtual void Kitware.VTK.vtkRowQuery.CaseSensitiveFieldNamesOff ( ) [virtual]

Many databases do not preserve case in field names. This can cause GetFieldIndex to fail if you search for a field named someFieldName when the database actually stores it as SOMEFIELDNAME. This ivar controls whether GetFieldIndex() expects field names to be case-sensitive. The default is OFF, i.e. case is not preserved.

virtual void Kitware.VTK.vtkRowQuery.CaseSensitiveFieldNamesOn ( ) [virtual]

Many databases do not preserve case in field names. This can cause GetFieldIndex to fail if you search for a field named someFieldName when the database actually stores it as SOMEFIELDNAME. This ivar controls whether GetFieldIndex() expects field names to be case-sensitive. The default is OFF, i.e. case is not preserved.

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

Reimplemented in Kitware.VTK.vtkSQLiteQuery, Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkPostgreSQLQuery, and Kitware.VTK.vtkSQLQuery.

virtual bool Kitware.VTK.vtkRowQuery.Execute ( ) [virtual]

Execute the query. This must be performed before any field name or data access functions are used.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, Kitware.VTK.vtkSQLQuery, and Kitware.VTK.vtkPostgreSQLQuery.

virtual bool Kitware.VTK.vtkRowQuery.GetCaseSensitiveFieldNames ( ) [virtual]

Many databases do not preserve case in field names. This can cause GetFieldIndex to fail if you search for a field named someFieldName when the database actually stores it as SOMEFIELDNAME. This ivar controls whether GetFieldIndex() expects field names to be case-sensitive. The default is OFF, i.e. case is not preserved.

int Kitware.VTK.vtkRowQuery.GetFieldIndex ( string name )

Return the index of the specified query field. Uses GetNumberOfFields() and GetFieldName() to match field name.

virtual string Kitware.VTK.vtkRowQuery.GetFieldName ( int i ) [virtual]

Return the name of the specified query field.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

virtual int Kitware.VTK.vtkRowQuery.GetFieldType ( int i ) [virtual]

Return the type of the field, using the constants defined in vtkType.h.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

virtual string Kitware.VTK.vtkRowQuery.GetLastErrorText ( ) [virtual]

Get the last error text from the query.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

virtual int Kitware.VTK.vtkRowQuery.GetNumberOfFields ( ) [virtual]

The number of fields in the query result.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

virtual bool Kitware.VTK.vtkRowQuery.HasError ( ) [virtual]

Returns true if an error is set, otherwise false.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, Kitware.VTK.vtkSQLQuery, and Kitware.VTK.vtkPostgreSQLQuery.

virtual bool Kitware.VTK.vtkRowQuery.IsActive ( ) [virtual]

Return true if the query is active (i.e. execution was successful and results are ready to be fetched). Returns false on error or inactive query.

Reimplemented in Kitware.VTK.vtkSQLQuery.

static new int Kitware.VTK.vtkRowQuery.IsTypeOf ( string type ) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, Kitware.VTK.vtkSQLQuery, and Kitware.VTK.vtkPostgreSQLQuery.

new vtkRowQuery Kitware.VTK.vtkRowQuery.NewInstance ( )

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, Kitware.VTK.vtkSQLQuery, and Kitware.VTK.vtkPostgreSQLQuery.

virtual bool Kitware.VTK.vtkRowQuery.NextRow ( ) [virtual]

Advance row, return false if past end.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, and Kitware.VTK.vtkPostgreSQLQuery.

bool Kitware.VTK.vtkRowQuery.NextRow ( vtkVariantArray rowArray )

Advance row, return false if past end. Also, fill array with row values.

static new vtkRowQuery Kitware.VTK.vtkRowQuery.SafeDownCast ( vtkObjectBase o ) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkMySQLQuery, Kitware.VTK.vtkSQLiteQuery, Kitware.VTK.vtkSQLQuery, and Kitware.VTK.vtkPostgreSQLQuery.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkRowQuery.SetCaseSensitiveFieldNames ( bool _arg ) [virtual]

Many databases do not preserve case in field names. This can cause GetFieldIndex to fail if you search for a field named someFieldName when the database actually stores it as SOMEFIELDNAME. This ivar controls whether GetFieldIndex() expects field names to be case-sensitive. The default is OFF, i.e. case is not preserved.

static internal void Kitware.VTK.vtkRowQuery.vtkRowQuery_CaseSensitiveFieldNamesOff_01 ( HandleRef pThis ) [private]

static internal void Kitware.VTK.vtkRowQuery.vtkRowQuery_CaseSensitiveFieldNamesOn_02 ( HandleRef pThis ) [private]

static internal byte Kitware.VTK.vtkRowQuery.vtkRowQuery_Execute_03 ( HandleRef pThis ) [private]

static internal byte Kitware.VTK.vtkRowQuery.vtkRowQuery_GetCaseSensitiveFieldNames_04 ( HandleRef pThis ) [private]

static internal int Kitware.VTK.vtkRowQuery.vtkRowQuery_GetFieldIndex_05	(	HandleRef	pThis,
		string	name
	)		`[private]`

static internal IntPtr Kitware.VTK.vtkRowQuery.vtkRowQuery_GetFieldName_06	(	HandleRef	pThis,
		int	i
	)		`[private]`

static internal int Kitware.VTK.vtkRowQuery.vtkRowQuery_GetFieldType_07	(	HandleRef	pThis,
		int	i
	)		`[private]`

static internal IntPtr Kitware.VTK.vtkRowQuery.vtkRowQuery_GetLastErrorText_08 ( HandleRef pThis ) [private]

static internal int Kitware.VTK.vtkRowQuery.vtkRowQuery_GetNumberOfFields_09 ( HandleRef pThis ) [private]

static internal byte Kitware.VTK.vtkRowQuery.vtkRowQuery_HasError_10 ( HandleRef pThis ) [private]

static internal int Kitware.VTK.vtkRowQuery.vtkRowQuery_IsA_11	(	HandleRef	pThis,
		string	type
	)		`[private]`

static internal byte Kitware.VTK.vtkRowQuery.vtkRowQuery_IsActive_12 ( HandleRef pThis ) [private]

static internal int Kitware.VTK.vtkRowQuery.vtkRowQuery_IsTypeOf_13 ( string type ) [private]

static internal IntPtr Kitware.VTK.vtkRowQuery.vtkRowQuery_NewInstance_14	(	HandleRef	pThis,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		`[private]`

static internal byte Kitware.VTK.vtkRowQuery.vtkRowQuery_NextRow_15 ( HandleRef pThis ) [private]

static internal byte Kitware.VTK.vtkRowQuery.vtkRowQuery_NextRow_16	(	HandleRef	pThis,
		HandleRef	rowArray
	)		`[private]`

static internal IntPtr Kitware.VTK.vtkRowQuery.vtkRowQuery_SafeDownCast_17	(	HandleRef	o,
		ref uint	mteStatus,
		ref uint	mteIndex,
		ref uint	rawRefCount
	)		`[private]`