DtLuaPathJob Class Reference

Lua object class which represents a feature navigation task. More...

Inheritance diagram for DtLuaPathJob:

Public Types
typedef std::vector< DtLocation3D >	Points

Public Member Functions
	DtLuaPathJob ()
	For creating when deserializing.
	~DtLuaPathJob ()
	DTOR.
luabind::object	getObject (lua_State *L, int &index, std::string &message)
	Retrieve value.
void	addMessage (DtAlgorithmManager::Severity, std::string)
	Sets the output message in a thread-safe manner.
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< DtLuaPathJob >	shared_from_this ()
boost::shared_ptr< const DtLuaPathJob >	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 < DtLuaPathJob >	Make (DtSimManager *mgr, DtString obstacleType, DtString pathType, const DtLocation3D &start, const DtLocation3D &dest, double buffer)
static DtAsciiSerializable *	creator ()
	DtAsciiSerializable functions.

Protected Types
typedef DtMutex	Mutex

Protected Member Functions
	DtLuaPathJob (DtSimManager *mgr, DtString obstacles, DtString paths, const DtLocation3D &start, const DtLocation3D &dest, double buffer)
	For creating from lua call.
void	start ()
void	run (const DtAlgorithmManager &mgr=DtAlgorithmManager())
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 ()

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
DtSimManager *	mySimManager

Friends
class	PathTask

Detailed Description

Lua object class which represents a feature navigation task.

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 ( DtSimManager *  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 ( DtSimManager *  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.

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:

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