DtLuaPathJob Class Reference

Lua object class which represents a feature navigation task.

Inheritance diagram for DtLuaPathJob:

Public Types
typedef std::vector< DtLocation3D >	Points

Public Member Functions
	DtLuaPathJob ()
	~DtLuaPathJob ()
luabind::object	getObject (lua_State *L, int &index, std::string &message)
luabind::object	getDebugObject (lua_State *L)
virtual void	cancel (lua_State *L)
void	addMessage (DtAlgorithmManager::Severity, std::string)
DtString	serialize ()
bool	deserialize (const DtString &)
DtString	objectType () const
boost::shared_ptr< DtLuaPathJob >	shared_from_this ()
boost::shared_ptr< const DtLuaPathJob >	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 < DtLuaPathJob >	Make (DtSimulationServices *mgr, DtString obstacleType, DtString pathType, const DtLocation3D &start, const DtLocation3D &dest, double buffer)
static DtAsciiSerializable *	creator ()

Protected Types
typedef DtMutex	Mutex

Protected Member Functions
	DtLuaPathJob (DtSimulationServices *mgr, DtString obstacles, DtString paths, const DtLocation3D &start, const DtLocation3D &dest, double buffer)
void	start ()
void	run (const DtAlgorithmManager &mgr=DtAlgorithmManager())
void	taskComplete ()
Protected Member Functions inherited from DtLuaAsyncJob
	DtLuaAsyncJob ()
	DtLuaAsyncJob (DtSimulationServices *)

Protected Attributes
Mutex	myMutex
std::string	myObstaclesType
std::string	myPathType
DtLocation3D	myStart
DtLocation3D	myDest
double	myBuffer
boost::scoped_ptr< Points >	myPoints
boost::shared_ptr < DtAsyncJobMapEntry >	myJobEntry
std::string	myMessage
Protected Attributes inherited from DtLuaAsyncJob
DtSimulationServices *	mySimulationServices

Friends
class	PathTask

Member Typedef Documentation

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

typedef DtMutex DtLuaPathJob::Mutex

protected

Constructor & Destructor Documentation

DtLuaPathJob::DtLuaPathJob

(

)

For creating when deserializing.

DtLuaPathJob::~DtLuaPathJob

(

)

DTOR.

DtLuaPathJob::DtLuaPathJob ( DtSimulationServices *  mgr, DtString  obstacles, DtString  paths, const DtLocation3D &  start, const DtLocation3D &  dest, double  buffer  )

protected

For creating from lua call.

Member Function Documentation

static boost::shared_ptr<DtLuaPathJob> DtLuaPathJob::Make ( DtSimulationServices *  mgr, DtString  obstacleType, DtString  pathType, const DtLocation3D &  start, const DtLocation3D &  dest, double  buffer  )

static

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

virtual

Retrieve value.

Implements DtLuaAsyncJob.

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

inlinevirtual

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

Implements DtLuaAsyncJob.

virtual void DtLuaPathJob::cancel ( lua_State *  L )

inlinevirtual

Currently a no-op.

Implements DtLuaAsyncJob.

void DtLuaPathJob::addMessage	(	DtAlgorithmManager::Severity	,
		std::string
	)

Sets the output message in a thread-safe manner.

static DtAsciiSerializable* DtLuaPathJob::creator ( )

static

DtAsciiSerializable functions.

DtString DtLuaPathJob::serialize ( )

virtual

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

Implements DtAsciiSerializable.

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

(

)

boost::shared_ptr<const DtLuaPathJob> DtLuaPathJob::shared_from_this

(

)

const

void DtLuaPathJob::start ( )

protected

void DtLuaPathJob::run ( const DtAlgorithmManager &  mgr = DtAlgorithmManager() )

protected

void DtLuaPathJob::taskComplete ( )

protected

Called by task object whenever it is done.

Friends And Related Function Documentation

friend class PathTask

friend

Member Data Documentation

Mutex DtLuaPathJob::myMutex

mutableprotected

std::string DtLuaPathJob::myObstaclesType

protected

std::string DtLuaPathJob::myPathType

protected

DtLocation3D DtLuaPathJob::myStart

protected

DtLocation3D DtLuaPathJob::myDest

protected

double DtLuaPathJob::myBuffer

protected

boost::scoped_ptr<Points> DtLuaPathJob::myPoints

protected

boost::shared_ptr<DtAsyncJobMapEntry> DtLuaPathJob::myJobEntry

protected

std::string DtLuaPathJob::myMessage

protected

---

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

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