DtNavAreaQuery Class Reference

Base class for all asynchronous Nav Area queries. In this context asynchronous means non-blocking. The queries may be performed in this thread or another thread, depending on configuration, but the result will take some time to complete. The calling function must call the complete() method to determine when the query has finished.

Inheritance diagram for DtNavAreaQuery:

Public Types
typedef std::shared_ptr < DtNavAreaQuery >	Ptr
typedef std::weak_ptr < DtNavAreaQuery >	WeakPtr

Public Member Functions
	DtNavAreaQuery ()
virtual	~DtNavAreaQuery ()
virtual bool	complete ()=0
virtual bool	tick ()=0
virtual bool	success ()=0
virtual bool	navDataChanged ()=0
virtual bool	outOfWorkingMemory ()=0
virtual bool	hadComputationError ()=0
virtual std::vector< DtVector >	results ()=0
virtual double	outputValue ()
virtual std::vector< DtVector >	debugPoints ()
virtual void *	internalQuery ()=0

Member Typedef Documentation

typedef std::shared_ptr<DtNavAreaQuery> DtNavAreaQuery::Ptr

typedef std::weak_ptr<DtNavAreaQuery> DtNavAreaQuery::WeakPtr

Constructor & Destructor Documentation

DtNavAreaQuery::DtNavAreaQuery ( )

inline

virtual DtNavAreaQuery::~DtNavAreaQuery ( )

inlinevirtual

Member Function Documentation

virtual bool DtNavAreaQuery::complete ( )

pure virtual

Returns true when the query has completed.

Implemented in DtNavAreaNullQuery.

virtual bool DtNavAreaQuery::tick ( )

pure virtual

Main function for performing query processing.

Implemented in DtNavAreaNullQuery.

virtual bool DtNavAreaQuery::success ( )

pure virtual

Returns true if the query completed successfully.

Implemented in DtNavAreaNullQuery.

virtual bool DtNavAreaQuery::navDataChanged ( )

pure virtual

Returns true if the nav data has changed during this query.

Implemented in DtNavAreaNullQuery.

virtual bool DtNavAreaQuery::outOfWorkingMemory ( )

pure virtual

Returns true if the query failed due to a lack of working memory.

Implemented in DtNavAreaNullQuery.

virtual bool DtNavAreaQuery::hadComputationError ( )

pure virtual

Returns true if the query failed due to a computation error.

Implemented in DtNavAreaNullQuery.

virtual std::vector<DtVector> DtNavAreaQuery::results ( )

pure virtual

A list of locations that may be the result of this query.

Implemented in DtNavAreaNullQuery.

virtual double DtNavAreaQuery::outputValue ( )

inlinevirtual

An output value that may be the result of this query. May not relevant to all queries.

virtual std::vector<DtVector> DtNavAreaQuery::debugPoints ( )

inlinevirtual

A list of locations that may be generated to debug issues. May not relevant to all queries.

virtual void* DtNavAreaQuery::internalQuery ( )

pure virtual

A pointer to the internal query. Not generally used.

Implemented in DtNavAreaNullQuery.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfNavigation/navArea.h