DtAsyncJob Class Reference

An asynchronous job that can be added to and executed by a job server. More...

Inheritance diagram for DtAsyncJob:

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

Protected Attributes
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

An asynchronous job that can be added to and executed by a job server.

Since this class derives from tbb::task it MUST use the the tbb task new operator. Ex: new (tbb::task::allocate_root()) DtAsyncJob(); Note that this class is abstract and cannot actually be instantiated, but all concrete subclasses must also follow this rule.

Constructor & Destructor Documentation

DtAsyncJob::DtAsyncJob

(

)

CTOR.

virtual DtAsyncJob::~DtAsyncJob ( )

virtual

Virtual DTOR.

Member Function Documentation

virtual task* DtAsyncJob::execute ( )

virtual

Do not override. Calls onExecute, then onException if there is an exception thrown.

Reimplemented in DtAsyncDetachedJob.

virtual task* DtAsyncJob::onExecute ( )

pure virtual

Called to execute a task.

Implemented in MAKVRinTerra::DtMakePathJob.

virtual task* DtAsyncJob::onException ( )

pure virtual

Called when an exception is caught during execution.

Implemented in MAKVRinTerra::DtMakePathJob.

virtual void DtAsyncJob::tick ( )

virtual

Called each tick.

virtual boost::shared_ptr<DtAsyncJobMapEntry> DtAsyncJob::getEntry ( ) const

pure virtual

Returns the entry associated with this task.

If it is null the task is no longer needed.

Implemented in DtAsyncDetachedJob, and DtAsyncManagedJob.

virtual void DtAsyncJob::setEntry ( boost::shared_ptr< DtAsyncJobMapEntry >  )

pure virtual

Set the job entry.

Implemented in DtAsyncDetachedJob, and DtAsyncManagedJob.

bool DtAsyncJob::cancel ( ) const

virtual

DtAlgorithmManager cancel function.

Reimplemented from DtAlgorithmManager.

Member Data Documentation

DtAsyncJobServer* DtAsyncJob::myServer

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfutil/asyncJob.h