Lua object class which represents a feature navigation task. More...

Inheritance diagram for DtLuaNavJob:

Public Types
typedef std::list< DtLocation3D >	Points

Public Member Functions
	DtLuaNavJob ()
	For creating when deserializing.
	~DtLuaNavJob ()
	DTOR.
virtual luabind::object	getObject (lua_State *L, int &index, std::string &message)=0
	Retrieve value.
virtual luabind::object	getDebugObject (lua_State *L)
	Retrieve debug data, if available. Default behavior is an empty table.
virtual void	cancel (lua_State *L)
	Cancels the job. By default this is a no-op, we let the job finish on its own.
void	addMessage (DtAlgorithmManager::Severity, std::string)
	Sets the output message in a thread-safe manner.
virtual DtString	serialize ()
	DtAsciiSerializable functions.
virtual bool	deserialize (const DtString &)
	This function should take the string that was serialized via serialize() and fill this object with the correct data.
virtual DtString	objectType () const =0
	Should return the string name of this object.
virtual void	run (const DtAlgorithmManager &mgr=DtAlgorithmManager())=0
virtual bool	complete ()=0
Public Member Functions inherited from DtLuaAsyncJob
void	init (void *userData)
	Called by framework with userData set to the DtSimManager.
Public Member Functions inherited from DtAsciiSerializable
	DtAsciiSerializable ()
	The implementer of this interface should be sure to create a creator function to create an empty object that returns a pointer to this interface.
	DtAsciiSerializable (const DtAsciiSerializable &orig)
virtual	~DtAsciiSerializable ()
virtual std::string	objectTypeC () const
	Returns a std::string version of the objectType.

Protected Member Functions
	DtLuaNavJob (DtSimManager *mgr, DtString navigationProfile, DtLocation3D startPoint, DtLocation3D accessPoint=DtLocation3D(DtVector::zero()), Points boundingArea=Points())
	For creating from lua call.
virtual void	start ()
virtual void	taskComplete ()=0
	Called by task object whenever it is done.
Protected Member Functions inherited from DtLuaAsyncJob
	DtLuaAsyncJob ()
	DtLuaAsyncJob (DtSimManager *)
Protected Member Functions inherited from DtObjectDebugger< DtLuaAsyncJob >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
DtString	myNavigationProfile
DtLocation3D	myStartPoint
DtLocation3D	myAccessPoint
Points	myBoundingArea
std::string	myMessage
DtNavAreaQuery::Ptr	myQuery
Protected Attributes inherited from DtLuaAsyncJob
DtSimManager *	mySimManager

Additional Inherited Members
Static Public Member Functions inherited from DtObjectDebugger< DtAsciiSerializable >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()
Static Public Member Functions inherited from DtObjectDebugger< DtLuaAsyncJob >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Detailed Description

Lua object class which represents a feature navigation task.

Member Typedef Documentation

typedef std::list<DtLocation3D> DtLuaNavJob::Points

Constructor & Destructor Documentation

DtLuaNavJob::DtLuaNavJob ( )

For creating when deserializing.

DtLuaNavJob::~DtLuaNavJob ( )

DTOR.

DtLuaNavJob::DtLuaNavJob	(	DtSimManager *	mgr,
		DtString	navigationProfile,
		DtLocation3D	startPoint,
		DtLocation3D	accessPoint = `DtLocation3D(DtVector::zero())`,
		Points	boundingArea = `Points()`
	)

protected

For creating from lua call.

Member Function Documentation

virtual luabind::object DtLuaNavJob::getObject	(	lua_State *	L,
		int &	index,
		std::string &	message
	)

pure virtual

Retrieve value.

Implements DtLuaAsyncJob.

Implemented in DtLuaNavFindPathJob, DtLuaNavCoverPointJob, DtLuaNavPointOfInterestJob, and DtLuaNavRandomPointJob.

virtual luabind::object DtLuaNavJob::getDebugObject ( lua_State * L )

inlinevirtual

Retrieve debug data, if available. Default behavior is an empty table.

Implements DtLuaAsyncJob.

Reimplemented in DtLuaNavRandomPointJob.

virtual void DtLuaNavJob::cancel ( lua_State * L )

inlinevirtual

Cancels the job. By default this is a no-op, we let the job finish on its own.

Implements DtLuaAsyncJob.

Reimplemented in DtLuaNavRandomPointJob.

void DtLuaNavJob::addMessage	(	DtAlgorithmManager::Severity	,
		std::string
	)

Sets the output message in a thread-safe manner.

virtual DtString DtLuaNavJob::serialize ( )

virtual

DtAsciiSerializable functions.

Implements DtAsciiSerializable.

virtual bool DtLuaNavJob::deserialize ( const DtString & )

virtual

This function should take the string that was serialized via serialize() and fill this object with the correct data.

Implements DtAsciiSerializable.

virtual DtString DtLuaNavJob::objectType ( ) const

pure virtual

Should return the string name of this object.

The object name should not be part of the serialization unless you want it to be, but you should take it into account when implementing both functions.

Implements DtAsciiSerializable.

Implemented in DtLuaNavFindPathJob, DtLuaNavCoverPointJob, DtLuaNavPointOfInterestJob, and DtLuaNavRandomPointJob.

virtual void DtLuaNavJob::run ( const DtAlgorithmManager & mgr = DtAlgorithmManager() )