DtLuaEmbarkationEgressPointsQueryJob Class Reference

Lua object class which represents a query for embarkation ingress and egress point info.

Inheritance diagram for DtLuaEmbarkationEgressPointsQueryJob:

Public Types
typedef std::vector< DtLocation3D >	Points

Public Member Functions
	DtLuaEmbarkationEgressPointsQueryJob ()
	~DtLuaEmbarkationEgressPointsQueryJob ()
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 < DtLuaEmbarkationEgressPointsQueryJob >	shared_from_this ()
boost::shared_ptr< const DtLuaEmbarkationEgressPointsQueryJob >	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 < DtLuaEmbarkationEgressPointsQueryJob >	Make (DtSimulationServices *mgr, DtSimObjectReference queryingObject, DtSimObjectReference objectToBeQueried)
static void	responseCallback (DtSimMessage *msg, void *usr)
static DtAsciiSerializable *	creator ()

Protected Types
typedef DtMutex	Mutex

Protected Member Functions
	DtLuaEmbarkationEgressPointsQueryJob (DtSimulationServices *mgr, DtSimObjectReference queryingObject, DtSimObjectReference objectToBeQueried)
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
int	myRequestId
bool	myGotResponse
DtIfEmbarkationEgressPointsResponse::EgressPointInformationMap	myEgressInfo
Mutex	myMutex
Protected Attributes inherited from DtLuaAsyncJob
DtSimulationServices *	mySimulationServices

Friends
class	PathTask

Member Typedef Documentation

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

typedef DtMutex DtLuaEmbarkationEgressPointsQueryJob::Mutex

protected

Constructor & Destructor Documentation

DtLuaEmbarkationEgressPointsQueryJob::DtLuaEmbarkationEgressPointsQueryJob

(

)

For creating when deserializing.

DtLuaEmbarkationEgressPointsQueryJob::~DtLuaEmbarkationEgressPointsQueryJob

(

)

DTOR.

DtLuaEmbarkationEgressPointsQueryJob::DtLuaEmbarkationEgressPointsQueryJob ( DtSimulationServices *  mgr, DtSimObjectReference  queryingObject, DtSimObjectReference  objectToBeQueried  )

protected

For creating from lua call.

Member Function Documentation

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

static

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

virtual

Retrieve value.

Implements DtLuaAsyncJob.

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

inlinevirtual

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

Implements DtLuaAsyncJob.

virtual void DtLuaEmbarkationEgressPointsQueryJob::cancel ( lua_State *  L )

inlinevirtual

Currently a no-op.

Implements DtLuaAsyncJob.

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

static

Processes the query response.

virtual void DtLuaEmbarkationEgressPointsQueryJob::processResponse ( DtSimMessage *  msg )

virtual

static DtAsciiSerializable* DtLuaEmbarkationEgressPointsQueryJob::creator ( )

static

DtAsciiSerializable functions.

DtString DtLuaEmbarkationEgressPointsQueryJob::serialize ( )

virtual

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

Implements DtAsciiSerializable.

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

(

)

boost::shared_ptr<const DtLuaEmbarkationEgressPointsQueryJob> DtLuaEmbarkationEgressPointsQueryJob::shared_from_this

(

)

const

static int DtLuaEmbarkationEgressPointsQueryJob::nextRequestId ( )

inlinestaticprotected

void DtLuaEmbarkationEgressPointsQueryJob::start ( )

protected

void DtLuaEmbarkationEgressPointsQueryJob::taskComplete ( )

protected

Called by task object whenever it is done.

Friends And Related Function Documentation

friend class PathTask

friend

Member Data Documentation

DtSimObjectReference DtLuaEmbarkationEgressPointsQueryJob::myQueryingObject

protected

DtSimObjectReference DtLuaEmbarkationEgressPointsQueryJob::myObjectBeingQueried

protected

int DtLuaEmbarkationEgressPointsQueryJob::myRequestId

protected

bool DtLuaEmbarkationEgressPointsQueryJob::myGotResponse

protected

DtIfEmbarkationEgressPointsResponse::EgressPointInformationMap DtLuaEmbarkationEgressPointsQueryJob::myEgressInfo

protected

Mutex DtLuaEmbarkationEgressPointsQueryJob::myMutex

mutableprotected

---

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

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