X-Git-Url: http://plrg.eecs.uci.edu/git/?p=model-checker.git;a=blobdiff_plain;f=traceanalysis.h;h=df3356ad50d422c08a3a2ba7d09234ccec394f5f;hp=43c6ebacfac7d9d2a94b0bbd27335e5b8c975396;hb=698f6194f9e5cc5905727c1798c36fede8c7ce8a;hpb=b090a4abc4915a9aa2a29787f76a6add79f838e2

diff --git a/traceanalysis.h b/traceanalysis.h
index 43c6eba..df3356a 100644
--- a/traceanalysis.h
+++ b/traceanalysis.h
@@ -4,9 +4,32 @@
 
 class TraceAnalysis {
  public:
+	/** setExecution is called once after installation with a reference to
+	 *  the ModelExecution object. */
+
 	virtual void setExecution(ModelExecution * execution) = 0;
+	
+	/** analyze is called once for each feasible trace with the complete
+	 *  action_list object. */
+
 	virtual void analyze(action_list_t *) = 0;
-	virtual char * name() = 0;
+
+	/** name returns the analysis name string */
+
+	virtual const char * name() = 0;
+
+	/** Each analysis option is passed into the option method.  This
+	 *	occurs before installation (i.e., you don't have a
+	 *	ModelExecution object yet).  A TraceAnalysis object should
+	 *	support the option "help"  */
+
+	virtual bool option(char *) = 0;
+
+	/** The finish method is called once at the end.  This should be
+	 *  used to print out results.  */
+
+	virtual void finish() = 0;
+
 	SNAPSHOTALLOC
 };
 #endif