Adding NS3 FDNetDevice RM
[nepi.git] / src / nepi / execution / trace.py
index 4ad5774..12e93c4 100644 (file)
 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
 
 class TraceAttr:
-    """ Trace attributes represent different information
-    aspects that can be retrieved from a trace.
+    """A Trace attribute defines information about a Trace that can
+    be queried
     """
-    ALL = 'all'
-    STREAM = 'stream'
-    PATH = 'path'
-    SIZE = 'size'
+    ALL = "all"
+    STREAM = "stream"
+    PATH = "path"
+    SIZE = "size"
 
 class Trace(object):
-    """
-    .. class:: Class Args :
-      
-        :param name: Name of the trace
-        :type name: str
-        :param help: Help about the trace
-        :type help: str
-
+    """ 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 = enabled