X-Git-Url: http://plrg.eecs.uci.edu/git/?p=model-checker.git;a=blobdiff_plain;f=traceanalysis.h;h=d363150ab3c72e2c3efcd46a2b8dd7d88dd970a8;hp=fe60591f68603d55dcc2a5c546c11099c2866050;hb=HEAD;hpb=a4d3f2ae3f3a9e2a30cc36c92cee9f83bb09e9b1;ds=sidebyside

diff --git a/traceanalysis.h b/traceanalysis.h
index fe60591..d363150 100644
--- a/traceanalysis.h
+++ b/traceanalysis.h
@@ -2,13 +2,49 @@
 #define TRACE_ANALYSIS_H
 #include "model.h"
 
+
 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;
+
+	/** This method is used to inspect the normal/abnormal model
+	 * action. */
+	virtual void inspectModelAction(ModelAction *act) {}
+
+	/** This method will be called by when a plugin is installed by the
+	 * model checker. */
+	virtual void actionAtInstallation() {}
+
+	/** This method will be called when the model checker finishes the
+	 * executions; With this method, the model checker can alter the
+	 * state of the plugin and then the plugin can choose whether or not
+	 * restart the model checker. */
+	virtual void actionAtModelCheckingFinish() {}
+
 	SNAPSHOTALLOC
 };
 #endif