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

Inheritance diagram for DtLuaEmbarkationEgressPointsQueryJob:

Public Types
typedef std::vector< DtLocation3D >	Points

Public Member Functions
	DtLuaEmbarkationEgressPointsQueryJob ()
	For creating when deserializing. More...

	~DtLuaEmbarkationEgressPointsQueryJob ()
	DTOR. More...

luabind::object	getObject (lua_State *L, int &index, std::string &message)
	Retrieve value. More...

luabind::object	getDebugObject (lua_State *L)
	Retrieve debug data, if available. Default return value is an empty table. More...

virtual void	cancel (lua_State *L)
	Currently a no-op. More...

virtual void	processResponse (DtSimMessage *msg)

DtString	serialize ()
	The following characters are reserved and cannot be used in serialization: '\|', ':'. More...

bool	deserialize (const DtString &)
	This function should take the string that was serialized via serialize() and fill this object with the correct data. More...

DtString	objectType () const
	Should return the string name of this object. More...

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)
	Called by framework with userData set to the DtSimManager. More...

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. More...

	DtAsciiSerializable (const DtAsciiSerializable &orig)

virtual	~DtAsciiSerializable ()

virtual std::string	objectTypeC () const
	Returns a std::string version of the objectType. More...

Static Public Member Functions
static boost::shared_ptr < DtLuaEmbarkationEgressPointsQueryJob >	Make (DtSimManager *mgr, DtSharedVrfObjectReference queryingObject, DtSharedVrfObjectReference objectToBeQueried)

static void	responseCallback (DtSimMessage msg, void usr)
	Processes the query response. More...

static DtAsciiSerializable *	creator ()
	DtAsciiSerializable functions. More...

Static Public Member Functions inherited from DtObjectDebugger< DtAsciiSerializable >
static DtObjectCounter::CounterType	ObjectCount ()

static const DtObjectContainer *	ObjectContainer ()

Static Public Member Functions inherited from DtObjectDebugger< DtLuaAsyncJob >
static DtObjectCounter::CounterType	ObjectCount ()

static const DtObjectContainer *	ObjectContainer ()

Protected Types
typedef DtMutex	Mutex

Protected Member Functions
	DtLuaEmbarkationEgressPointsQueryJob (DtSimManager *mgr, DtSharedVrfObjectReference queryingObject, DtSharedVrfObjectReference objectToBeQueried)
	For creating from lua call. More...

void	start ()

void	taskComplete ()
	Called by task object whenever it is done. More...

Protected Member Functions inherited from DtLuaAsyncJob
	DtLuaAsyncJob ()

	DtLuaAsyncJob (DtSimManager *)

Protected Member Functions inherited from DtObjectDebugger< DtAsciiSerializable >
	DtObjectDebugger ()

	DtObjectDebugger (const DtObjectDebugger &)

	~DtObjectDebugger ()

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

DtIfEmbarkationEgressPointsResponse::EgressPointInformationMap	myEgressInfo

Mutex	myMutex

Protected Attributes inherited from DtLuaAsyncJob
DtSimManager *	mySimManager

Friends
class	PathTask

Detailed Description

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

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

protected

For creating from lua call.

Member Function Documentation

static boost::shared_ptr<DtLuaEmbarkationEgressPointsQueryJob> DtLuaEmbarkationEgressPointsQueryJob::Make	(	DtSimManager *	mgr,
		DtSharedVrfObjectReference	queryingObject,
		DtSharedVrfObjectReference	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

DtSharedVrfObjectReference DtLuaEmbarkationEgressPointsQueryJob::myQueryingObject

protected

DtSharedVrfObjectReference 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.vrf4-8-branch/include/vrfLua/luaEmbarkationEgressPointsQueryJob.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation