DtLuaAsyncJob Class Reference

Interface for getting asynchronously computed data into Lua. More...

Inheritance diagram for DtLuaAsyncJob:

Public Member Functions
virtual luabind::object	getObject (lua_State *L, int &index, std::string &message)=0
	Retrieve current value. More...
virtual luabind::object	getDebugObject (lua_State *L)=0
	Returns debug data. More...
virtual void	cancel (lua_State *L)=0
	Cancels the job. More...
void	init (void *userData)
	Called by framework with userData set to the DtSimManager. More...
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. More...
	DtAsciiSerializable (const DtAsciiSerializable &orig)
virtual	~DtAsciiSerializable ()
virtual DtString	objectType () const =0
	Should return the string name of this object. More...
virtual std::string	objectTypeC () const
	Returns a std::string version of the objectType. More...
virtual DtString	serialize ()=0
	The following characters are reserved and cannot be used in serialization: '|', ':'. More...
virtual bool	deserialize (const DtString &)=0
	This function should take the string that was serialized via serialize() and fill this object with the correct data. More...

Protected Member Functions
	DtLuaAsyncJob ()
	DtLuaAsyncJob (DtSimManager *)

Protected Attributes
DtSimManager *	mySimManager

Detailed Description

Interface for getting asynchronously computed data into Lua.

The class is designed to be a general interface to some process which is computing values. The getObject function returns the "current" value and some control information. The subclass is responsible for all aspects of the asynchronous operation: Starting/stopping, data synchronization, and serialization/deserialization. The Lua framework will hold on to this object as a shared pointer.

Constructor & Destructor Documentation

DtLuaAsyncJob::DtLuaAsyncJob ( )

protected

DtLuaAsyncJob::DtLuaAsyncJob ( DtSimManager *  )

explicitprotected

Member Function Documentation

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

pure virtual

Retrieve current value.

Parameters

L	Lua state.
index	Index of returned value, returned in Lua as the second return value. Allows implementation to distinguish between different values computed over time.
message	Error message, returned in Lua as the third return value.

Returns

Computed value.

Implemented in DtLuaNavFindPathJob, DtLuaNavCoverPointJob, DtLuaNavPointOfInterestJob, DtLuaNavRandomPointJob, DtLuaPathJob, DtLuaEmbarkationEgressPointsQueryJob, DtLuaEmbarkationSlotQueryJob, DtLuaEmbarkationSlotReservationJob, and DtLuaNavJob.

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

pure virtual

Returns debug data.

Not generally used.

Parameters

L	Lua state.

Returns

Debug data.

Implemented in DtLuaNavFindPathJob, DtLuaNavRandomPointJob, DtLuaPathJob, DtLuaEmbarkationEgressPointsQueryJob, DtLuaEmbarkationSlotQueryJob, DtLuaEmbarkationSlotReservationJob, and DtLuaNavJob.

virtual void DtLuaAsyncJob::cancel ( lua_State *  L )

pure virtual

Cancels the job.

Implemented in DtLuaNavRandomPointJob, DtLuaPathJob, DtLuaEmbarkationEgressPointsQueryJob, DtLuaEmbarkationSlotQueryJob, DtLuaEmbarkationSlotReservationJob, and DtLuaNavJob.

void DtLuaAsyncJob::init ( void *  userData )

virtual

Called by framework with userData set to the DtSimManager.

Reimplemented from DtAsciiSerializable.

Member Data Documentation

DtSimManager* DtLuaAsyncJob::mySimManager

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfLua/luaAsyncJob.h