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

Inheritance diagram for DtLuaEmbarkationSlotReservationJob:

Public Types
typedef std::vector< DtLocation3D >	Points

Public Member Functions
	DtLuaEmbarkationSlotReservationJob ()

	~DtLuaEmbarkationSlotReservationJob ()

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 < DtLuaEmbarkationSlotReservationJob >	shared_from_this ()

boost::shared_ptr< const DtLuaEmbarkationSlotReservationJob >	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 < DtLuaEmbarkationSlotReservationJob >	Make (DtSimulationServices *mgr, DtSimObjectReference embarkingObject, DtSimObjectReference objectToEmbarkedOn, int slotNumber)

static void	responseCallback (DtSimMessage msg, void usr)

static DtAsciiSerializable *	creator ()

Protected Types
typedef DtMutex	Mutex

Protected Member Functions
	DtLuaEmbarkationSlotReservationJob (DtSimulationServices *mgr, DtSimObjectReference embarkingObject, DtSimObjectReference objectToEmbarkedOn, int slotNumber)

void	start ()

void	taskComplete ()

Protected Member Functions inherited from DtLuaAsyncJob
	DtLuaAsyncJob ()

	DtLuaAsyncJob (DtSimulationServices *)

Static Protected Member Functions
static int	nextRequestId ()

Protected Attributes
DtSimObjectReference	myEmbarkingObject

DtSimObjectReference	myObjectToEmbarkOn

int	mySlotNumber

int	myRequestId

bool	myGotResponse

bool	mySlotAvailable

DtTaitBryan	myOrientation

DtVector	myPosition

Mutex	myMutex

Protected Attributes inherited from DtLuaAsyncJob
DtSimulationServices *	mySimulationServices

Friends
class	PathTask

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	(	DtSimulationServices *	mgr,
		DtSimObjectReference	embarkingObject,
		DtSimObjectReference	objectToEmbarkedOn,
		int	slotNumber
	)

protected

For creating from lua call.

Member Function Documentation

static boost::shared_ptr<DtLuaEmbarkationSlotReservationJob> DtLuaEmbarkationSlotReservationJob::Make	(	DtSimulationServices *	mgr,
		DtSimObjectReference	embarkingObject,
		DtSimObjectReference	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

DtSimObjectReference DtLuaEmbarkationSlotReservationJob::myEmbarkingObject

protected

DtSimObjectReference 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:

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation