DtLuaEmbarkationSlotQueryJob Class Reference

Lua object class which represents a query for embarkation slot info.

Inheritance diagram for DtLuaEmbarkationSlotQueryJob:

Public Types
typedef std::vector< DtLocation3D >	Points

Public Member Functions
	DtLuaEmbarkationSlotQueryJob ()
	~DtLuaEmbarkationSlotQueryJob ()
luabind::object	getObject (lua_State *L, int &index, std::string &message)
luabind::object	getDebugObject (lua_State *L)
virtual void	cancel (lua_State *L)
virtual void	processResponse (DtSimMessage *msg)
DtString	serialize ()
bool	deserialize (const DtString &)
DtString	objectType () const
boost::shared_ptr < DtLuaEmbarkationSlotQueryJob >	shared_from_this ()
boost::shared_ptr< const DtLuaEmbarkationSlotQueryJob >	shared_from_this () const
Public Member Functions inherited from DtLuaAsyncJob
void	init (void *userData)
Public Member Functions inherited from DtAsciiSerializable
	DtAsciiSerializable ()
	DtAsciiSerializable (const DtAsciiSerializable &orig)
virtual	~DtAsciiSerializable ()
virtual std::string	objectTypeC () const

Static Public Member Functions
static boost::shared_ptr < DtLuaEmbarkationSlotQueryJob >	Make (DtSimulationServices *mgr, DtSimObjectReference queryingObject, DtSimObjectReference objectToBeQueried, bool bAllSlots)
static void	responseCallback (DtSimMessage *msg, void *usr)
static DtAsciiSerializable *	creator ()

Protected Types
typedef DtMutex	Mutex

Protected Member Functions
	DtLuaEmbarkationSlotQueryJob (DtSimulationServices *mgr, DtSimObjectReference queryingObject, DtSimObjectReference objectToBeQueried, bool bAllSlots)
void	start ()
void	taskComplete ()
Protected Member Functions inherited from DtLuaAsyncJob
	DtLuaAsyncJob ()
	DtLuaAsyncJob (DtSimulationServices *)

Static Protected Member Functions
static int	nextRequestId ()

Protected Attributes
DtSimObjectReference	myQueryingObject
DtSimObjectReference	myObjectBeingQueried
bool	myAllSlots
int	myRequestId
bool	myGotResponse
DtIfEmbarkationSlotInformationResponse::SlotInformationMap	mySlotInfo
Mutex	myMutex
Protected Attributes inherited from DtLuaAsyncJob
DtSimulationServices *	mySimulationServices

Friends
class	PathTask

Member Typedef Documentation

typedef std::vector<DtLocation3D> DtLuaEmbarkationSlotQueryJob::Points

typedef DtMutex DtLuaEmbarkationSlotQueryJob::Mutex

protected

Constructor & Destructor Documentation

DtLuaEmbarkationSlotQueryJob::DtLuaEmbarkationSlotQueryJob

(

)

For creating when deserializing.

DtLuaEmbarkationSlotQueryJob::~DtLuaEmbarkationSlotQueryJob

(

)

DTOR.

DtLuaEmbarkationSlotQueryJob::DtLuaEmbarkationSlotQueryJob ( DtSimulationServices *  mgr, DtSimObjectReference  queryingObject, DtSimObjectReference  objectToBeQueried, bool  bAllSlots  )

protected

For creating from lua call.

Member Function Documentation

static boost::shared_ptr<DtLuaEmbarkationSlotQueryJob> DtLuaEmbarkationSlotQueryJob::Make ( DtSimulationServices *  mgr, DtSimObjectReference  queryingObject, DtSimObjectReference  objectToBeQueried, bool  bAllSlots  )

static

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

virtual

Retrieve value.

Implements DtLuaAsyncJob.

luabind::object DtLuaEmbarkationSlotQueryJob::getDebugObject ( lua_State *  L )

inlinevirtual

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

Implements DtLuaAsyncJob.

virtual void DtLuaEmbarkationSlotQueryJob::cancel ( lua_State *  L )

inlinevirtual

Currently a no-op.

Implements DtLuaAsyncJob.

static void DtLuaEmbarkationSlotQueryJob::responseCallback ( DtSimMessage *  msg, void *  usr  )

static

Processes the query response.

virtual void DtLuaEmbarkationSlotQueryJob::processResponse ( DtSimMessage *  msg )

virtual

static DtAsciiSerializable* DtLuaEmbarkationSlotQueryJob::creator ( )

static

DtAsciiSerializable functions.

DtString DtLuaEmbarkationSlotQueryJob::serialize ( )

virtual

The following characters are reserved and cannot be used in serialization: '|', ':'.

Implements DtAsciiSerializable.

bool DtLuaEmbarkationSlotQueryJob::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.

DtString DtLuaEmbarkationSlotQueryJob::objectType ( ) const

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.

boost::shared_ptr<DtLuaEmbarkationSlotQueryJob> DtLuaEmbarkationSlotQueryJob::shared_from_this

(

)

boost::shared_ptr<const DtLuaEmbarkationSlotQueryJob> DtLuaEmbarkationSlotQueryJob::shared_from_this

(

)

const

static int DtLuaEmbarkationSlotQueryJob::nextRequestId ( )

inlinestaticprotected

void DtLuaEmbarkationSlotQueryJob::start ( )

protected

void DtLuaEmbarkationSlotQueryJob::taskComplete ( )

protected

Called by task object whenever it is done.

Friends And Related Function Documentation

friend class PathTask

friend

Member Data Documentation

DtSimObjectReference DtLuaEmbarkationSlotQueryJob::myQueryingObject

protected

DtSimObjectReference DtLuaEmbarkationSlotQueryJob::myObjectBeingQueried

protected

bool DtLuaEmbarkationSlotQueryJob::myAllSlots

protected

int DtLuaEmbarkationSlotQueryJob::myRequestId

protected

bool DtLuaEmbarkationSlotQueryJob::myGotResponse

protected

DtIfEmbarkationSlotInformationResponse::SlotInformationMap DtLuaEmbarkationSlotQueryJob::mySlotInfo

protected

Mutex DtLuaEmbarkationSlotQueryJob::myMutex

mutableprotected

---

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

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