DtAsyncManagedJob Class Reference

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.

Inheritance diagram for DtAsyncManagedJob:

Public Member Functions
boost::shared_ptr < DtAsyncJobMapEntry >	getEntry () const
void	setEntry (boost::shared_ptr< DtAsyncJobMapEntry >)
Public Member Functions inherited from DtAsyncJob
	DtAsyncJob ()
virtual	~DtAsyncJob ()
virtual task *	execute ()
virtual task *	onExecute ()=0
virtual task *	onException ()=0
virtual void	tick ()
bool	cancel () const
Public Member Functions inherited from DtAlgorithmManager
virtual void	message (Severity, const std::string &) const
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
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_LEVEL }
typedef DtTaggedException < DtAlgorithmManager >	Exception

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:

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