DtLuaAsyncJob Class Reference

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.

Inheritance diagram for DtLuaAsyncJob:

Public Member Functions
virtual luabind::object	getObject (lua_State *L, int &index, std::string &message)=0
virtual luabind::object	getDebugObject (lua_State *L)=0
virtual void	cancel (lua_State *L)=0
virtual void	init (void *userData) override
Public Member Functions inherited from DtAsciiSerializable
	DtAsciiSerializable ()
	DtAsciiSerializable (const DtAsciiSerializable &orig)
virtual	~DtAsciiSerializable ()
virtual DtString	objectType () const =0
virtual std::string	objectTypeC () const
virtual DtString	serialize ()=0
virtual bool	deserialize (const DtString &)=0

Protected Member Functions
	DtLuaAsyncJob ()
	DtLuaAsyncJob (DtSimulationServices *)

Protected Attributes
DtSimulationServices *	mySimulationServices

Constructor & Destructor Documentation

DtLuaAsyncJob::DtLuaAsyncJob ( )

protected

DtLuaAsyncJob::DtLuaAsyncJob ( DtSimulationServices *  )

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 DtLuaFindPositionGroupsInAreaUsingRidgeQueryJob, DtLuaNavPlaceFormationJob, DtLuaNavFindPathJob, DtLuaFindPositionGroupsInAreaUsingHilltopsQueryJob, DtLuaNavCoverPointJob, DtLuaFindSinglePositionQueryJob, DtLuaNavPointOfInterestJob, DtLuaVehicleFightingPositionQueryJob, DtLuaNavRandomPointJob, DtLuaPathJob, DtLuaWeaponListQueryJob, DtLuaPlaceFormationJob, DtLuaEmbarkationEgressPointsQueryJob, DtLuaEmbarkationSlotQueryJob, DtLuaHilltopQueryJob, 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 DtLuaFindPositionGroupsInAreaUsingRidgeQueryJob, DtLuaNavFindPathJob, DtLuaFindPositionGroupsInAreaUsingHilltopsQueryJob, DtLuaFindSinglePositionQueryJob, DtLuaVehicleFightingPositionQueryJob, DtLuaNavRandomPointJob, DtLuaPathJob, DtLuaWeaponListQueryJob, DtLuaPlaceFormationJob, DtLuaEmbarkationEgressPointsQueryJob, DtLuaEmbarkationSlotQueryJob, DtLuaHilltopQueryJob, DtLuaEmbarkationSlotReservationJob, and DtLuaNavJob.

virtual void DtLuaAsyncJob::cancel ( lua_State *  L )

pure virtual

Cancels the job.

Implemented in DtLuaFindPositionGroupsInAreaUsingRidgeQueryJob, DtLuaFindPositionGroupsInAreaUsingHilltopsQueryJob, DtLuaFindSinglePositionQueryJob, DtLuaVehicleFightingPositionQueryJob, DtLuaNavRandomPointJob, DtLuaPathJob, DtLuaWeaponListQueryJob, DtLuaPlaceFormationJob, DtLuaEmbarkationEgressPointsQueryJob, DtLuaEmbarkationSlotQueryJob, DtLuaHilltopQueryJob, DtLuaEmbarkationSlotReservationJob, and DtLuaNavJob.

virtual void DtLuaAsyncJob::init ( void *  userData )

overridevirtual

Called by framework with userData set to the DtSimulationServices.

Reimplemented from DtAsciiSerializable.

Member Data Documentation

DtSimulationServices* DtLuaAsyncJob::mySimulationServices

protected

---

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

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