VTK
9.1.0
|
abstract interface for queries that return row-oriented results. More...
#include <vtkRowQuery.h>
Public Types | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkRowQuery * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual bool | Execute ()=0 |
Execute the query. More... | |
virtual int | GetNumberOfFields ()=0 |
The number of fields in the query result. More... | |
virtual const char * | GetFieldName (int i)=0 |
Return the name of the specified query field. More... | |
virtual int | GetFieldType (int i)=0 |
Return the type of the field, using the constants defined in vtkType.h. More... | |
int | GetFieldIndex (const char *name) |
Return the index of the specified query field. More... | |
virtual bool | NextRow ()=0 |
Advance row, return false if past end. More... | |
virtual bool | IsActive ()=0 |
Return true if the query is active (i.e. More... | |
bool | NextRow (vtkVariantArray *rowArray) |
Advance row, return false if past end. More... | |
virtual vtkVariant | DataValue (vtkIdType c)=0 |
Return data in current row, field c. More... | |
virtual bool | HasError ()=0 |
Returns true if an error is set, otherwise false. More... | |
virtual const char * | GetLastErrorText ()=0 |
Get the last error text from the query. More... | |
virtual void | SetCaseSensitiveFieldNames (bool) |
Many databases do not preserve case in field names. More... | |
virtual bool | GetCaseSensitiveFieldNames () |
Many databases do not preserve case in field names. More... | |
virtual void | CaseSensitiveFieldNamesOn () |
Many databases do not preserve case in field names. More... | |
virtual void | CaseSensitiveFieldNamesOff () |
Many databases do not preserve case in field names. More... | |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. More... | |
virtual void | DebugOff () |
Turn debugging output off. More... | |
bool | GetDebug () |
Get the value of the debug flag. More... | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. More... | |
virtual void | Modified () |
Update the modification time for this object. More... | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. More... | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
vtkTypeBool | HasObserver (unsigned long event) |
vtkTypeBool | HasObserver (const char *event) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More... | |
virtual void | Delete () |
Delete a VTK object. More... | |
virtual void | FastDelete () |
Delete a reference to this object. More... | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. More... | |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). More... | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). More... | |
int | GetReferenceCount () |
Return the current reference count of this object. More... | |
void | SetReferenceCount (int) |
Sets the reference count. More... | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. More... | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkRowQuery * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. More... | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
Static Public Member Functions inherited from vtkObjectBase | |
static vtkTypeBool | IsTypeOf (const char *name) |
Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More... | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More... | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkRowQuery () | |
~vtkRowQuery () override | |
Protected Member Functions inherited from vtkObject | |
vtkObject () | |
~vtkObject () override | |
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
These methods allow a command to exclusively grab all events. More... | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. More... | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
bool | CaseSensitiveFieldNames |
Protected Attributes inherited from vtkObject | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
Protected Attributes inherited from vtkObjectBase | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Additional Inherited Members | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
abstract interface for queries that return row-oriented results.
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.
Definition at line 62 of file vtkRowQuery.h.
typedef vtkObject vtkRowQuery::Superclass |
Definition at line 65 of file vtkRowQuery.h.
|
protected |
|
overrideprotected |
|
static |
|
virtual |
Return 1 if this class is the same type of (or a subclass of) the named class.
Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObjectBase.
Reimplemented in vtkQtSQLQuery, vtkMySQLQuery, vtkODBCQuery, vtkPostgreSQLQuery, vtkSQLiteQuery, and vtkSQLQuery.
|
static |
|
protectedvirtual |
Reimplemented in vtkQtSQLQuery, vtkMySQLQuery, vtkODBCQuery, vtkPostgreSQLQuery, vtkSQLiteQuery, and vtkSQLQuery.
vtkRowQuery * vtkRowQuery::NewInstance | ( | ) | const |
|
overridevirtual |
Methods invoked by print to print information about the object including superclasses.
Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkObject.
Reimplemented in vtkSQLiteQuery, and vtkSQLQuery.
|
pure virtual |
Execute the query.
This must be performed before any field name or data access functions are used.
Implemented in vtkQtSQLQuery, vtkMySQLQuery, vtkODBCQuery, vtkPostgreSQLQuery, vtkSQLiteQuery, and vtkSQLQuery.
|
pure virtual |
The number of fields in the query result.
Implemented in vtkQtSQLQuery, vtkMySQLQuery, vtkODBCQuery, vtkPostgreSQLQuery, and vtkSQLiteQuery.
|
pure virtual |
Return the name of the specified query field.
Implemented in vtkQtSQLQuery, vtkMySQLQuery, vtkODBCQuery, vtkPostgreSQLQuery, and vtkSQLiteQuery.
|
pure virtual |
Return the type of the field, using the constants defined in vtkType.h.
Implemented in vtkQtSQLQuery, vtkMySQLQuery, vtkODBCQuery, vtkPostgreSQLQuery, and vtkSQLiteQuery.
int vtkRowQuery::GetFieldIndex | ( | const char * | name | ) |
Return the index of the specified query field.
Uses GetNumberOfFields() and GetFieldName() to match field name.
|
pure virtual |
Advance row, return false if past end.
Implemented in vtkQtSQLQuery, vtkMySQLQuery, vtkODBCQuery, vtkPostgreSQLQuery, and vtkSQLiteQuery.
|
pure 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.
Implemented in vtkSQLQuery.
bool vtkRowQuery::NextRow | ( | vtkVariantArray * | rowArray | ) |
Advance row, return false if past end.
Also, fill array with row values.
|
pure virtual |
Return data in current row, field c.
Implemented in vtkQtSQLQuery, vtkMySQLQuery, vtkODBCQuery, vtkPostgreSQLQuery, and vtkSQLiteQuery.
|
pure virtual |
Returns true if an error is set, otherwise false.
Implemented in vtkQtSQLQuery, vtkMySQLQuery, vtkODBCQuery, vtkPostgreSQLQuery, and vtkSQLiteQuery.
|
pure virtual |
Get the last error text from the query.
Implemented in vtkQtSQLQuery, vtkMySQLQuery, vtkODBCQuery, vtkPostgreSQLQuery, and vtkSQLiteQuery.
|
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 |
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 |
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 |
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.
|
protected |
Definition at line 147 of file vtkRowQuery.h.