VR-Forces 4.2 Class Documentation
List of all members | Public Member Functions | Protected Attributes
DtAsyncJob Class Reference

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

Inheritance diagram for DtAsyncJob:
Inheritance graph
[legend]

Public Member Functions

 DtAsyncJob ()
 CTOR.
virtual ~DtAsyncJob ()
 Virtual DTOR.
virtual taskexecute ()
 Do not override. Calls onExecute, then onException if there is an exception thrown.
virtual taskonExecute ()=0
 Called to execute a task.
virtual taskonException ()=0
 Called when an exception is caught during execution.
virtual boost::shared_ptr
< DtAsyncJobMapEntry
getEntry () const
 Returns the entry associated with this task.
virtual void setEntry (boost::shared_ptr< DtAsyncJobMapEntry >)
 Set the job entry.

Protected Attributes

boost::weak_ptr
< DtAsyncJobMapEntry
myEntry
DtAsyncJobServermyServer

Detailed Description

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

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.

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 boost::shared_ptr<DtAsyncJobMapEntry> DtAsyncJob::getEntry ( ) const
virtual

Returns the entry associated with this task.

If it is null the task is no longer needed.

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

Set the job entry.

Member Data Documentation

boost::weak_ptr<DtAsyncJobMapEntry> DtAsyncJob::myEntry
protected
DtAsyncJobServer* DtAsyncJob::myServer
protected

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

Document ID: Generated on Sun Nov 24 19:49:21 EST 2013 from SVN revision 133924
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)