README moves to markdown

[nepi.git] / src / nepi / execution / trace.py

diff --git a/src/nepi/execution/trace.py b/src/nepi/execution/trace.py
index 3ecf83f..c685527 100644 (file)
--- a/src/nepi/execution/trace.py
+++ b/src/nepi/execution/trace.py
@@ -1,39 +1,57 @@
-"""
-    NEPI, a framework to manage network experiments
-    Copyright (C) 2013 INRIA
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 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.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-"""
+#
+#    NEPI, a framework to manage network experiments
+#    Copyright (C) 2013 INRIA
+#
+#    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 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.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Author: Alina Quereilhac <alina.quereilhac@inria.fr>
 
 class TraceAttr:
-    ALL = 'all'
-    STREAM = 'stream'
-    PATH = 'path'
-    SIZE = 'size'
+    """A Trace attribute defines information about a Trace that can
+    be queried
+    """
+    ALL = "all"
+    STREAM = "stream"
+    PATH = "path"
+    SIZE = "size"
 
 class Trace(object):
-    def __init__(self, name, help):
+    """ A Trace represents information about a Resource that can 
+    be collected 
+    """
+
+    def __init__(self, name, help, enabled = False):
+        """
+        :param name: Name of the Trace
+        :type name: str
+
+        :param help: Description of the Trace
+        :type help: str
+        
+        :param enabled: Sets activation state of Trace
+        :type enabled: bool
+        """
         self._name = name
         self._help = help
-        self.enabled = False
+        self.enabled = enabled
 
     @property
     def name(self):
+        """ Returns the name of the trace """
         return self._name
 
     @property
     def help(self):
+        """ Returns the help of the trace """
         return self._help