vtkQtSQLQuery Class Reference

query class associated with vtkQtSQLDatabase More...

#include <vtkQtSQLQuery.h>

Inheritance diagram for vtkQtSQLQuery:

Collaboration diagram for vtkQtSQLQuery:

Public Types
typedef vtkSQLQuery	Superclass
Public Types inherited from vtkSQLQuery
typedef vtkRowQuery	Superclass
Public Types inherited from vtkRowQuery
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.
vtkQtSQLQuery *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
bool	Execute () override
	Execute the query.
int	GetNumberOfFields () override
	The number of fields in the query result.
const char *	GetFieldName (int col) override
	Return the name of the specified query field.
int	GetFieldType (int col) override
	Return the type of the specified query field, as defined in vtkType.h.
bool	NextRow () override
	Advance row, return false if past end.
vtkVariant	DataValue (vtkIdType c) override
	Return data in current row, field c.
bool	HasError () override
	Returns true if an error is set, otherwise false.
const char *	GetLastErrorText () override
	Get the last error text from the query.
Public Member Functions inherited from vtkSQLQuery
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkSQLQuery *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
bool	IsActive () override
	Return true if the query is active (i.e.
bool	Execute () override=0
	Execute the query.
virtual bool	BeginTransaction ()
	Begin, commit, or roll back a transaction.
virtual bool	CommitTransaction ()
virtual bool	RollbackTransaction ()
virtual bool	BindParameter (int index, unsigned char value)
	Bind a parameter to a placeholder in a query.
virtual bool	BindParameter (int index, unsigned short value)
virtual bool	BindParameter (int index, unsigned int value)
virtual bool	BindParameter (int index, unsigned long value)
virtual bool	BindParameter (int index, signed char value)
virtual bool	BindParameter (int index, short value)
virtual bool	BindParameter (int index, int value)
virtual bool	BindParameter (int index, long value)
virtual bool	BindParameter (int index, unsigned long long value)
virtual bool	BindParameter (int index, long long value)
virtual bool	BindParameter (int index, float value)
virtual bool	BindParameter (int index, double value)
virtual bool	BindParameter (int index, const char *stringValue)
	Bind a string value – string must be null-terminated.
virtual bool	BindParameter (int index, const char *stringValue, size_t length)
	Bind a string value by specifying an array and a size.
virtual bool	BindParameter (int index, const vtkStdString &string)
virtual bool	BindParameter (int index, vtkVariant var)
virtual bool	BindParameter (int index, const void *data, size_t length)
	Bind a blob value.
virtual bool	ClearParameterBindings ()
	Reset all parameter bindings to nullptr.
virtual vtkStdString	EscapeString (vtkStdString s, bool addSurroundingQuotes=true)
	Escape a string for inclusion into an SQL query.
char *	EscapeString (const char *src, bool addSurroundingQuotes)
	Escape a string for inclusion into an SQL query.
virtual bool	SetQuery (const char *query)
	The query string to be executed.
virtual const char *	GetQuery ()
	The query string to be executed.
virtual vtkSQLDatabase *	GetDatabase ()
	Return the database associated with the query.
Public Member Functions inherited from vtkRowQuery
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkRowQuery *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual bool	Execute ()=0
	Execute the query.
virtual int	GetNumberOfFields ()=0
	The number of fields in the query result.
virtual const char *	GetFieldName (int i)=0
	Return the name of the specified query field.
virtual int	GetFieldType (int i)=0
	Return the type of the field, using the constants defined in vtkType.h.
int	GetFieldIndex (const char *name)
	Return the index of the specified query field.
virtual bool	NextRow ()=0
	Advance row, return false if past end.
virtual bool	IsActive ()=0
	Return true if the query is active (i.e.
bool	NextRow (vtkVariantArray *rowArray)
	Advance row, return false if past end.
virtual vtkVariant	DataValue (vtkIdType c)=0
	Return data in current row, field c.
virtual bool	HasError ()=0
	Returns true if an error is set, otherwise false.
virtual const char *	GetLastErrorText ()=0
	Get the last error text from the query.
virtual void	SetCaseSensitiveFieldNames (bool)
	Many databases do not preserve case in field names.
virtual bool	GetCaseSensitiveFieldNames ()
	Many databases do not preserve case in field names.
virtual void	CaseSensitiveFieldNamesOn ()
	Many databases do not preserve case in field names.
virtual void	CaseSensitiveFieldNamesOff ()
	Many databases do not preserve case in field names.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
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.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
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.
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
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).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkQtSQLQuery *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkQtSQLQuery *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkSQLQuery
static vtkTypeBool	IsTypeOf (const char *type)
static vtkSQLQuery *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkRowQuery
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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
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).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkQtSQLQuery ()
	~vtkQtSQLQuery () override
Protected Member Functions inherited from vtkSQLQuery
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkSQLQuery ()
	~vtkSQLQuery () override
void	SetDatabase (vtkSQLDatabase *db)
	Set the database associated with the query.
Protected Member Functions inherited from vtkRowQuery
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.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
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
vtkQtSQLQueryInternals *	Internals
Protected Attributes inherited from vtkSQLQuery
char *	Query
vtkSQLDatabase *	Database
bool	Active
Protected Attributes inherited from vtkRowQuery
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

Friends
class	vtkQtSQLDatabase

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

query class associated with vtkQtSQLDatabase

Implements vtkSQLQuery using an underlying QSQLQuery.

Definition at line 37 of file vtkQtSQLQuery.h.

Member Typedef Documentation

Superclass

typedef vtkSQLQuery vtkQtSQLQuery::Superclass

Definition at line 41 of file vtkQtSQLQuery.h.

Constructor & Destructor Documentation

vtkQtSQLQuery()

vtkQtSQLQuery::vtkQtSQLQuery ( )

protected

~vtkQtSQLQuery()

vtkQtSQLQuery::~vtkQtSQLQuery ( )

overrideprotected

Member Function Documentation

New()

static vtkQtSQLQuery * vtkQtSQLQuery::New ( )

static

IsTypeOf()

static vtkTypeBool vtkQtSQLQuery::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkQtSQLQuery::IsA ( const char *  name )

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

SafeDownCast()

static vtkQtSQLQuery * vtkQtSQLQuery::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkQtSQLQuery::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkSQLQuery.

NewInstance()

vtkQtSQLQuery * vtkQtSQLQuery::NewInstance

(

)

const

PrintSelf()

void vtkQtSQLQuery::PrintSelf ( ostream &  os, vtkIndent  indent  )

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.

Execute()

bool vtkQtSQLQuery::Execute ( )

overridevirtual

Execute the query.

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

Implements vtkSQLQuery.

GetNumberOfFields()

int vtkQtSQLQuery::GetNumberOfFields ( )

overridevirtual

The number of fields in the query result.

Implements vtkRowQuery.

GetFieldName()

const char * vtkQtSQLQuery::GetFieldName ( int  col )

overridevirtual

Return the name of the specified query field.

Implements vtkRowQuery.

GetFieldType()

int vtkQtSQLQuery::GetFieldType ( int  col )

overridevirtual

Return the type of the specified query field, as defined in vtkType.h.

Implements vtkRowQuery.

NextRow()

bool vtkQtSQLQuery::NextRow ( )

overridevirtual

Advance row, return false if past end.

Implements vtkRowQuery.

DataValue()

vtkVariant vtkQtSQLQuery::DataValue ( vtkIdType  c )

overridevirtual

Return data in current row, field c.

Implements vtkRowQuery.

HasError()

bool vtkQtSQLQuery::HasError ( )

overridevirtual

Returns true if an error is set, otherwise false.

Implements vtkRowQuery.

GetLastErrorText()

const char * vtkQtSQLQuery::GetLastErrorText ( )

overridevirtual

Get the last error text from the query.

Implements vtkRowQuery.

Friends And Related Function Documentation

vtkQtSQLDatabase

friend class vtkQtSQLDatabase

friend

Definition at line 91 of file vtkQtSQLQuery.h.

Member Data Documentation

Internals

vtkQtSQLQueryInternals* vtkQtSQLQuery::Internals

protected

Definition at line 90 of file vtkQtSQLQuery.h.

---

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

• GUISupport/QtSQL/vtkQtSQLQuery.h