Kaim::CircleArcSplineComputationQuery Class Reference

Kaim::CircleArcSplineComputationQuery Class Reference

#include <circlearcsplinecomputationquery.h>

Class Description

Inherits Kaim::ITimeSlicedQuery.

Public Attributes

Databasem_database
 
QueryStatusInQueue m_inQueueStatus
 
QueryQueuem_queue
 
void * m_traverseLogicUserData
 

Functions to set up the query

void BindToDatabase (Database *database)
 
void Initialize (const Vec3f &startPosition, const ChannelSectionPtr &startSection, const Vec3f &endPosition, const ChannelSectionPtr &endSection)
 

write accessors for query parameters

void SetStartConstraint (const Vec2f &constraint)
 
void SetEndConstraint (const Vec2f &constraint)
 
void SetSplineConfig (const SplineComputationConfig &config)
 
SplineComputationConfig & GetSplineConfig ()
 

Query framework functions

virtual void Advance (WorkingMemory *workingMemory)
 
void PerformQuery (WorkingMemory *workingMemory=0)
 
virtual void ReleaseWorkingMemoryOnCancelDuringProcess (WorkingMemory *workingMemory=0)
 

Accessors

const SplineComputationConfig & GetSplineConfig () const
 
const Vec3fGetStartPos () const
 
const Vec3fGetEndPos () const
 
const ChannelSectionPtr & GetStartChannelSectionPtr () const
 
const ChannelSectionPtr & GetEndChannelSectionPtr () const
 
CircleArcSplineComputationQueryResult GetResult () const
 
const CircleArcSplineComputerGetComputer () const
 
CircleArcSplineComputationResult GetComputerResult () const
 
KyUInt32 GetOutputCount () const
 
const RadiusProfileCircleArcSplineComputerOutputGetOutput (KyUInt32 index) const
 

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
 

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 *)
 

Public Data Members

QueryProcessStatus m_processStatus
 
Ptr< IOnDonem_onDone
 

Public Member Functions

void Initialize ()
 

Member Function Documentation

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

Performs a single iteration of the spline computation query.

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
workingMemorySandbox memory used to perform queries.

Implements Kaim::IQuery.

void Kaim::CircleArcSplineComputationQuery::BindToDatabase ( Database database)

Binds the query with the specified Database, clears all the inputs and outputs and sets all other parameters to their default value (they may be changed by calling the corresponding write accessors.)

Parameters
databaseA pointer to the Database on which the query must be performed.
bool Kaim::IQuery::CanBeInitialized ( ) const
inlineinherited

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::CircleArcSplineComputationQuery::Initialize ( const Vec3f startPosition,
const ChannelSectionPtr &  startSection,
const Vec3f endPosition,
const ChannelSectionPtr &  endSection 
)

Sets an instance of this class with minimum input requirements.

Clears all the output, and let all other parameters unchanged. They may be changed by calling the corresponding write accessors.

Parameters
startPositionSets the value of #m_startPosition.
startSectionSets the value of #m_startSection.
endPositionSets the value of #m_endPosition.
endSectionSets the value of #m_endSection.
void Kaim::ITimeSlicedQuery::Initialize ( )
inlineinherited

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

This function calls IQuery::Initialize().

bool Kaim::IQuery::IsInAQueryQueue ( ) const
inlineinherited

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
inlineinherited

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 ( )
inlineinherited

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::CircleArcSplineComputationQuery::PerformQuery ( WorkingMemory *  workingMemory = 0)

Performs the query.

Parameters
workingMemorySandbox memory used to perform queries. If let to KY_NULL, the m_database internal WorkingMemory is used.
void Kaim::IQuery::PerformQueryBlocking ( WorkingMemory *  workingMemory = 0)
inherited

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

Parameters
workingMemorySandbox memory used to perform queries. If let to KY_NULL, the m_database internal WorkingMemory is used.
virtual void Kaim::CircleArcSplineComputationQuery::ReleaseWorkingMemoryOnCancelDuringProcess ( WorkingMemory *  workingMemory = 0)
virtual

Called when a query is canceled in FlushCommands while its status is QueryInProcess to make sure that the WorkingMemory is left in valid state (typically, no WorkingMemory buffer should be in used after this call).

Implements Kaim::ITimeSlicedQuery.

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

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

Member Data Documentation

Database* Kaim::IQuery::m_database
inherited

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

QueryStatusInQueue Kaim::IQuery::m_inQueueStatus
inherited

Used by the QueryQueue. Do not modify.

Ptr<IOnDone> Kaim::IQuery::m_onDone
inherited

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

QueryProcessStatus Kaim::IQuery::m_processStatus
inherited

Modified by the query within Advance().

Do not modify.

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

QueryQueue* Kaim::IQuery::m_queue
inherited

Updated by the QueryQueue. Do not modify.

void* Kaim::IQuery::m_traverseLogicUserData
inherited

This userData is typically passed by the Bot.


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