VR-Forces 5.0.2 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
DtAsyncDetachedJob Class Reference

Concrete job class which manages a shared pointer to it's job map entry. Using this job does not require the user who sets up the job to keep any references to it. This allows the user to start a job and not have to worry about saving anything objects to keep the job alive.

Inheritance diagram for DtAsyncDetachedJob:
Inheritance graph
[legend]

Public Member Functions

boost::shared_ptr
< DtAsyncJobMapEntry
getEntry () const
 
void setEntry (boost::shared_ptr< DtAsyncJobMapEntry >)
 
task * execute ()
 
- Public Member Functions inherited from DtAsyncJob
 DtAsyncJob ()
 
virtual ~DtAsyncJob ()
 
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::shared_ptr
< DtAsyncJobMapEntry
myEntry
 
- Protected Attributes inherited from DtAsyncJob
DtAsyncJobServermyServer
 

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> DtAsyncDetachedJob::getEntry ( ) const
virtual

Returns the entry associated with this task. If it is null the task is no longer needed.

Implements DtAsyncJob.

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

Set the job entry.

Implements DtAsyncJob.

task* DtAsyncDetachedJob::execute ( )
virtual

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

Reimplemented from DtAsyncJob.

Member Data Documentation

boost::shared_ptr<DtAsyncJobMapEntry> DtAsyncDetachedJob::myEntry
protected

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

Document ID: Generated on Sun Dec 4 20:22:03 EST 2022 from SVN revision 249613
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)