#include <iquery.h>

Class Description

Abstract class for all queries.

Inherits Kaim::RefCountBase< C, Stat >.

Inherited by Kaim::IAtomicQuery, and Kaim::ITimeSlicedQuery.

Public Attributes
Database *	m_database

QueryStatusInQueue	m_inQueueStatus

QueryQueue *	m_queue

void *	m_traverseLogicUserData

Main API Functions
bool	CanBeInitialized () const

bool	IsInAQueryQueue () const

bool	IsSafeToReadResult () const

void	PerformQueryBlocking (WorkingMemory *workingMemory=0)

void	OnDone ()

KyResult	SendVisualDebug ()

void	SetTraverseLogicUserData (void *traverseLogicUserData)

void *	GetTraverseLogicUserData () const

Pure virtual functions
virtual QueryType	GetType () const =0

virtual void	Advance (WorkingMemory *workingMemory)=0

For internal use only
static const char *	GetQueryTypeName (QueryType queryType)

Internal Virtual functions for NavigationLab Remote Query processing
These functions are used by IQuery::SendVisualDebug() and also used by the NavigationLab to request remote execution: using VisualDebugClient::Send(IQuery) to ask for a query to be executed using VisualDebugServer::Send(IQuery) to send back the query result. Queries that can be visual debug override these 3 functions. By convenience, such queries provide a static function with the following signature: /code static Ptr<BaseBlobHandler> CreateStaticQueryBlobHandler(); /endcode
virtual Ptr< BaseBlobHandler >	CreateQueryBlobHandler ()

virtual void	BuildQueryBlob (Kaim::BaseBlobHandler *)

virtual void	InitFromQueryBlob (World , void )

Mandatory initialization calls to be done by derived classes
void	BindToDatabase (Database *database)

void	Initialize ()

Public Data Members
QueryProcessStatus	m_processStatus

Ptr< IOnDone >	m_onDone

Member Function Documentation

virtual void Kaim::IQuery::Advance ( WorkingMemory * workingMemory )

pure virtual

This function is called by the QueryQueue to process one step on the query.

It MUST NEVER, under any circumstances, take too long. As a guideline, consider 0.1ms as too long.

It is under the responsibility of this function to update m_processStatus. Obviously, if the query is atomic (i.e. not time-sliced), a call to Advance() will fully perform the query and set m_processStatus to QueryDone. If the query is time-sliced, several calls to Advance() will be needed to complete the query; the first call should set m_processStatus to Kaim::QueryInProcess and the last one to Kaim::QueryDone.

Parameters

workingMemory Sandbox memory used to perform queries.

void Kaim::IQuery::BindToDatabase ( Database * database )

inline

Should be called by the derived class before Initializing the query It sets m_database to the provided value.

It sets #m_userData to KY_NULL;

bool Kaim::IQuery::CanBeInitialized ( ) const

inline

In the case of a query processed in a QueryQueue, this must be tested before initializing the query, to prevent modifying the query during the process.

void Kaim::IQuery::Initialize ( )

inline

Should be called by the derived class before trying to perform the query or to push it in a QueryQueue.

The query must have been bound to a Database before.

It sets m_processStatus to Kaim::QueryNotStarted. As some query framework components (such as QueryQueue) relies on these members, you cannot call SetUp() unless CanBeInitialized() returns true.

bool Kaim::IQuery::IsInAQueryQueue ( ) const

inline

Returns true if the query is currently registered in a QueryQueue.

If true, you must not push it again in QueryQueue (even the same one).

If false, you must not try to cancel it from the QueryQueue.

bool Kaim::IQuery::IsSafeToReadResult ( ) const

inline

Returns true if the query has been processed, is no longer in a queue, and OnDone (if there is one) has been called.

If true, it's guaranteed to be safe to read the results of this query.

Will return false if the Query has been cancelled or has not yet been processed.

void Kaim::IQuery::OnDone ( )

inline

Calls the OnDone function of the IOnDone object if provided.

Called automatically by the QueryQueue during the World::Update() (in FlushQueries() step) when this query has been completed.

Not called if this query is canceled.

Note that the member m_onDone is reset to KY_NULL at the end of this function.

void Kaim::IQuery::PerformQueryBlocking ( WorkingMemory * workingMemory = 0 )

Process the query at once whether it is time-sliced or not.

Parameters

workingMemory Sandbox memory used to perform queries. If let to KY_NULL, the m_database internal WorkingMemory is used.

void Kaim::IQuery::SetTraverseLogicUserData ( void * traverseLogicUserData )

inline

Should be set for queries templated by a traverse logic, useless otherwise.

Member Data Documentation

Database* Kaim::IQuery::m_database

The database on which the query will be performed. Set in Initialize(), do not directly modify.

QueryStatusInQueue Kaim::IQuery::m_inQueueStatus

Used by the QueryQueue. Do not modify.

Ptr<IOnDone> Kaim::IQuery::m_onDone

The optional IOnDone instance to be called. Must be set manually by the user. See IOnDone.

QueryProcessStatus Kaim::IQuery::m_processStatus

Modified by the query within Advance().

Do not modify.

Before reading m_processStatus, always ensure IsInAQueryQueue() returns false.

QueryQueue* Kaim::IQuery::m_queue

Updated by the QueryQueue. Do not modify.

void* Kaim::IQuery::m_traverseLogicUserData

This userData is typically passed by the Bot.

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

gwnavruntime/querysystem/iquery.h

Kaim::IQuery Class Reference

Class Description

Public Attributes

Main API Functions

Pure virtual functions

For internal use only

Internal Virtual functions for NavigationLab Remote Query processing

Mandatory initialization calls to be done by derived classes

Public Data Members

Member Function Documentation

Member Data Documentation