Revision: 41581
http://brlcad.svn.sourceforge.net/brlcad/?rev=41581&view=rev
Author: davidloman
Date: 2010-12-13 19:47:01 +0000 (Mon, 13 Dec 2010)
Log Message:
-----------
Added in some documenation on the functions.
Modified Paths:
--------------
rt^3/trunk/include/AbstractJob.h
Modified: rt^3/trunk/include/AbstractJob.h
===================================================================
--- rt^3/trunk/include/AbstractJob.h 2010-12-13 19:13:51 UTC (rev 41580)
+++ rt^3/trunk/include/AbstractJob.h 2010-12-13 19:47:01 UTC (rev 41581)
@@ -43,17 +43,49 @@
AbstractJob();
virtual ~AbstractJob();
+ /**
+ * Submits this job to the JobManager. (Dangerous, need to remove)
+ */
void submit();
+ /**
+ * Executes the code in _doJob(). This function performs status setup
and sanity checks prior to executing subclass code.
+ */
JobResult doJob();
+
+ /**
+ * Returns the current JobStatus of this Job.
+ */
JobStatus getStatus();
+
+ /**
+ * Returns the JobID for this job. JobID is a 32bit integer value.
+ */
quint32 getJobId();
protected:
+
+ /**
+ * Mandates subclass implementation of _doJob(). This function
provides the actual
+ * functionality that defines the subclass.
+ */
virtual JobResult _doJob() = 0;
+ /**
+ * Internal field for storing Job's ID.
+ */
quint32 jobID;
+
+ /**
+ * Internal field for storing Job's current status.
+ */
JobStatus status;
+
+private:
+ /* Disable copy cstr and =operator */
+ AbstractJob(AbstractJob const&){};
+ AbstractJob& operator=(AbstractJob const&){};
+
};
#endif /* __ABSTRACTJOB_H__ */
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Lotusphere 2011
Register now for Lotusphere 2011 and learn how
to connect the dots, take your collaborative environment
to the next level, and enter the era of Social Business.
http://p.sf.net/sfu/lotusphere-d2d
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
