X-Git-Url: http://plrg.eecs.uci.edu/git/?p=c11tester.git;a=blobdiff_plain;f=traceanalysis.h;h=df3356ad50d422c08a3a2ba7d09234ccec394f5f;hp=fe60591f68603d55dcc2a5c546c11099c2866050;hb=f817fff71c1cc97fe1bd55fa791f0d68af88ed1a;hpb=a4d3f2ae3f3a9e2a30cc36c92cee9f83bb09e9b1

diff --git a/traceanalysis.h b/traceanalysis.h
index fe60591f..df3356ad 100644
--- a/traceanalysis.h
+++ b/traceanalysis.h
@@ -4,11 +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;
+
+	/** 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