DtLuaEmbarkationSlotReservationJob Class Reference

Lua object class which represents a request to reserve an embarkation slot. More...

Inheritance diagram for DtLuaEmbarkationSlotReservationJob:

Public Types
typedef std::vector< DtLocation3D >	Points

Public Member Functions
	DtLuaEmbarkationSlotReservationJob ()
	For creating when deserializing.
	~DtLuaEmbarkationSlotReservationJob ()
	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 < DtLuaEmbarkationSlotReservationJob >	shared_from_this ()
boost::shared_ptr< const DtLuaEmbarkationSlotReservationJob >	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 < DtLuaEmbarkationSlotReservationJob >	Make (DtSimManager *mgr, DtSharedVrfObjectReference embarkingObject, DtSharedVrfObjectReference objectToEmbarkedOn, int slotNumber)
static void	responseCallback (DtSimMessage *msg, void *usr)
	Processes the query response.
static DtAsciiSerializable *	creator ()
	DtAsciiSerializable functions.

Protected Types
typedef DtMutex	Mutex

Protected Member Functions
	DtLuaEmbarkationSlotReservationJob (DtSimManager *mgr, DtSharedVrfObjectReference embarkingObject, DtSharedVrfObjectReference objectToEmbarkedOn, int slotNumber)
	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	myEmbarkingObject
DtSharedVrfObjectReference	myObjectToEmbarkOn
int	mySlotNumber
int	myRequestId
bool	myGotResponse
bool	mySlotAvailable
DtTaitBryan	myOrientation
DtVector	myPosition
Mutex	myMutex
Protected Attributes inherited from DtLuaAsyncJob
DtSimManager *	mySimManager

Friends
class	PathTask

Detailed Description

Lua object class which represents a request to reserve an embarkation slot.

Member Typedef Documentation

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

typedef DtMutex DtLuaEmbarkationSlotReservationJob::Mutex

protected

Constructor & Destructor Documentation

DtLuaEmbarkationSlotReservationJob::DtLuaEmbarkationSlotReservationJob

(

)

For creating when deserializing.

DtLuaEmbarkationSlotReservationJob::~DtLuaEmbarkationSlotReservationJob

(

)

DTOR.

DtLuaEmbarkationSlotReservationJob::DtLuaEmbarkationSlotReservationJob ( DtSimManager *  mgr, DtSharedVrfObjectReference  embarkingObject, DtSharedVrfObjectReference  objectToEmbarkedOn, int  slotNumber  )

protected

For creating from lua call.

Member Function Documentation

static boost::shared_ptr<DtLuaEmbarkationSlotReservationJob> DtLuaEmbarkationSlotReservationJob::Make ( DtSimManager *  mgr, DtSharedVrfObjectReference  embarkingObject, DtSharedVrfObjectReference  objectToEmbarkedOn, int  slotNumber  )

static

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

virtual

Retrieve value.

Implements DtLuaAsyncJob.

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

inlinevirtual

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

Implements DtLuaAsyncJob.

virtual void DtLuaEmbarkationSlotReservationJob::cancel ( lua_State *  L )

inlinevirtual

Currently a no-op.

Implements DtLuaAsyncJob.

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

static

Processes the query response.

virtual void DtLuaEmbarkationSlotReservationJob::processResponse ( DtSimMessage *  msg )

virtual

static DtAsciiSerializable* DtLuaEmbarkationSlotReservationJob::creator ( )

static

DtAsciiSerializable functions.

DtString DtLuaEmbarkationSlotReservationJob::serialize ( )

virtual

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

Implements DtAsciiSerializable.

bool DtLuaEmbarkationSlotReservationJob::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 DtLuaEmbarkationSlotReservationJob::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<DtLuaEmbarkationSlotReservationJob> DtLuaEmbarkationSlotReservationJob::shared_from_this

(

)

boost::shared_ptr<const DtLuaEmbarkationSlotReservationJob> DtLuaEmbarkationSlotReservationJob::shared_from_this

(

)

const

static int DtLuaEmbarkationSlotReservationJob::nextRequestId ( )

inlinestaticprotected

void DtLuaEmbarkationSlotReservationJob::start ( )

protected

void DtLuaEmbarkationSlotReservationJob::taskComplete ( )

protected

Called by task object whenever it is done.

Friends And Related Function Documentation

friend class PathTask

friend

Member Data Documentation

DtSharedVrfObjectReference DtLuaEmbarkationSlotReservationJob::myEmbarkingObject

protected

DtSharedVrfObjectReference DtLuaEmbarkationSlotReservationJob::myObjectToEmbarkOn

protected

int DtLuaEmbarkationSlotReservationJob::mySlotNumber

protected

int DtLuaEmbarkationSlotReservationJob::myRequestId

protected

bool DtLuaEmbarkationSlotReservationJob::myGotResponse

protected

bool DtLuaEmbarkationSlotReservationJob::mySlotAvailable

protected

DtTaitBryan DtLuaEmbarkationSlotReservationJob::myOrientation

protected

DtVector DtLuaEmbarkationSlotReservationJob::myPosition

protected

Mutex DtLuaEmbarkationSlotReservationJob::myMutex

mutableprotected

---

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

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