DtAsyncManagedJob Class Reference

Concrete job class which manages a weak pointer to it's job map entry. More...

Inheritance diagram for DtAsyncManagedJob:

Public Member Functions
boost::shared_ptr < DtAsyncJobMapEntry >	getEntry () const
	Returns the entry associated with this task.
void	setEntry (boost::shared_ptr< DtAsyncJobMapEntry >)
	Set the job entry.
Public Member Functions inherited from DtAsyncJob
	DtAsyncJob ()
	CTOR.
virtual	~DtAsyncJob ()
	Virtual DTOR.
virtual task *	execute ()
	Do not override. Calls onExecute, then onException if there is an exception thrown.
virtual task *	onExecute ()=0
	Called to execute a task.
virtual task *	onException ()=0
	Called when an exception is caught during execution.
virtual void	tick ()
	Called each tick.
bool	cancel () const
	DtAlgorithmManager cancel function.
Public Member Functions inherited from DtAlgorithmManager
virtual void	message (Severity, const std::string &) const
	Output a messages from within the algorithm.
void	errorMessage (const std::string &) const
void	warnMessage (const std::string &) const
void	infoMessage (const std::string &) const
void	verboseMessage (const std::string &) const
void	debugMessage (const std::string &) const
virtual MAKVRinTerra::DtSharedMemoryFeaturesDebugDrawer *	drawer () const
	Returns drawer, null if not enabled.

Protected Attributes
boost::weak_ptr < DtAsyncJobMapEntry >	myEntry
Protected Attributes inherited from DtAsyncJob
DtAsyncJobServer *	myServer

Additional Inherited Members
Public Types inherited from DtAlgorithmManager
enum	Severity {   Error, WARN, INFO, VERBOSE,   DEBUG }
typedef DtTaggedException < DtAlgorithmManager >	Exception
Static Public Member Functions inherited from DtObjectDebugger< DtAsyncJob >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()
Protected Member Functions inherited from DtObjectDebugger< DtAsyncJob >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Detailed Description

Concrete job class which manages a weak pointer to it's job map entry.

Using this job will require the user who sets up the job to keep a shared pointer to the job map entry to keep it alive. Thus a user can end the job by simply deleting their pointer.

Member Function Documentation

boost::shared_ptr<DtAsyncJobMapEntry> DtAsyncManagedJob::getEntry ( ) const

virtual

Returns the entry associated with this task.

If it is null the task is no longer needed.

Implements DtAsyncJob.

void DtAsyncManagedJob::setEntry ( boost::shared_ptr< DtAsyncJobMapEntry >  )

virtual

Set the job entry.

Implements DtAsyncJob.

Member Data Documentation

boost::weak_ptr<DtAsyncJobMapEntry> DtAsyncManagedJob::myEntry

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/asyncJob.h