DtLuaEmbarkationSlotQueryJob Class Reference

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

Inheritance diagram for DtLuaEmbarkationSlotQueryJob:

Public Types
typedef std::vector< DtLocation3D >	Points

Public Member Functions
	DtLuaEmbarkationSlotQueryJob ()
	For creating when deserializing.
	~DtLuaEmbarkationSlotQueryJob ()
	DTOR.
luabind::object	getObject (lua_State *L, int &index, std::string &message)
	Retrieve value.
luabind::object	getDebugObject (lua_State *L)
	Retrieve debug data, if available. Default return value is an empty table.
virtual void	cancel (lua_State *L)
	Currently a no-op.
virtual void	processResponse (DtSimMessage *msg)
DtString	serialize ()
	The following characters are reserved and cannot be used in serialization: '|', ':'.
bool	deserialize (const DtString &)
	This function should take the string that was serialized via serialize() and fill this object with the correct data.
DtString	objectType () const
	Should return the string name of this object.
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)
	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.

Static Public Member Functions
static boost::shared_ptr < DtLuaEmbarkationSlotQueryJob >	Make (DtSimManager *mgr, DtSharedVrfObjectReference queryingObject, DtSharedVrfObjectReference objectToBeQueried)
static void	responseCallback (DtSimMessage *msg, void *usr)
	Processes the query response.
static DtAsciiSerializable *	creator ()
	DtAsciiSerializable functions.

Protected Types
typedef DtMutex	Mutex

Protected Member Functions
	DtLuaEmbarkationSlotQueryJob (DtSimManager *mgr, DtSharedVrfObjectReference queryingObject, DtSharedVrfObjectReference objectToBeQueried)
	For creating from lua call.
void	start ()
void	taskComplete ()
	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 ()

Static Protected Member Functions
static int	nextRequestId ()

Protected Attributes
DtSharedVrfObjectReference	myQueryingObject
DtSharedVrfObjectReference	myObjectBeingQueried
int	myRequestId
bool	myGotResponse
DtIfEmbarkationSlotInformationResponse::SlotInformationMap	mySlotInfo
Mutex	myMutex
Protected Attributes inherited from DtLuaAsyncJob
DtSimManager *	mySimManager

Friends
class	PathTask

Detailed Description

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

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 ( DtSimManager *  mgr, DtSharedVrfObjectReference  queryingObject, DtSharedVrfObjectReference  objectToBeQueried  )

protected

For creating from lua call.

Member Function Documentation

static boost::shared_ptr<DtLuaEmbarkationSlotQueryJob> DtLuaEmbarkationSlotQueryJob::Make ( DtSimManager *  mgr, DtSharedVrfObjectReference  queryingObject, DtSharedVrfObjectReference  objectToBeQueried  )

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

DtSharedVrfObjectReference DtLuaEmbarkationSlotQueryJob::myQueryingObject

protected

DtSharedVrfObjectReference DtLuaEmbarkationSlotQueryJob::myObjectBeingQueried

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfLua/luaEmbarkationSlotQueryJob.h