Move and update documentation

[lttv.git] / lttv / lttv / sync / event_matching.h

diff --git a/lttv/lttv/sync/event_matching.h b/lttv/lttv/sync/event_matching.h
index 0c3fe2d1c82c335509e2c238c5de57a2a9d32eda..4e8befc35520c85fae46a6f3d5519f1c43879f8f 100644 (file)
--- a/lttv/lttv/sync/event_matching.h
+++ b/lttv/lttv/sync/event_matching.h
@@ -1,19 +1,18 @@
 /* This file is part of the Linux Trace Toolkit viewer
- * Copyright (C) 2009 Benjamin Poirier <benjamin.poirier@polymtl.ca>
+ * Copyright (C) 2009, 2010 Benjamin Poirier <benjamin.poirier@polymtl.ca>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License Version 2 as
- * published by the Free Software Foundation;
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 2.1 of the License, or (at
+ * your option) any later version.
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
+ * License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
- * MA 02111-1307, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef EVENT_MATCHING_H
@@ -21,26 +20,51 @@
 
 #include <glib.h>
 
-#include "data_structures_tcp.h"
-
+#include "data_structures.h"
+#include "graph_functions.h"
 
 struct _SyncState;
 
 typedef struct
 {
        char* name;
+       bool canMatch[TYPE_COUNT];
 
+       /*
+        * This function is called at the beginning of a synchronization run for a set
+        * of traces. Allocate the matching specific data structures.
+        */
        void (*initMatching)(struct _SyncState* const syncState);
+
+       /*
+        * Free the matching specific data structures.
+        */
        void (*destroyMatching)(struct _SyncState* const syncState);
 
-       void (*matchEvent)(struct _SyncState* const syncState, NetEvent* const event,
-               EventType eventType);
-       GArray* (*finalizeMatching)(struct _SyncState* const syncState);
+       /*
+        * Try to match one event from a trace with the corresponding event from
+        * another trace. If it is possible, create a new structure and call the
+        * analyse{message,exchange,broadcast} function of the analysis module.
+        */
+       void (*matchEvent)(struct _SyncState* const syncState, Event* const
+               event);
+
+       /*
+        * Obtain the factors from downstream.
+        */
+       AllFactors* (*finalizeMatching)(struct _SyncState* const syncState);
+
+       /*
+     * Print statistics related to matching. Is always called after
+     * finalizeMatching.
+     */
        void (*printMatchingStats)(struct _SyncState* const syncState);
-       void (*writeMatchingGraphsPlots)(FILE* stream, struct _SyncState* const
-               syncState, const unsigned int i, const unsigned int j);
-       void (*writeMatchingGraphsOptions)(FILE* stream, struct _SyncState* const
-               syncState, const unsigned int i, const unsigned int j);
+
+       /*
+        * Write the matching-specific options and graph commands in the gnuplot
+        * script. Is always called after finalizeMatching.
+        */
+       GraphFunctions graphFunctions;
 } MatchingModule;
 
 #endif