nepi/execution/trace.py

   1 #
   2 #    NEPI, a framework to manage network experiments
   3 #    Copyright (C) 2013 INRIA
   4 #
   5 #    This program is free software: you can redistribute it and/or modify
   6 #    it under the terms of the GNU General Public License version 2 as
   7 #    published by the Free Software Foundation;
   8 #
   9 #    This program is distributed in the hope that it will be useful,
  10 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 #    GNU General Public License for more details.
  13 #
  14 #    You should have received a copy of the GNU General Public License
  15 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 #
  17 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
  18
  19 class TraceAttr:
  20     """A Trace attribute defines information about a Trace that can
  21     be queried
  22     """
  23     ALL = "all"
  24     STREAM = "stream"
  25     PATH = "path"
  26     SIZE = "size"
  27
  28 class Trace(object):
  29     """ A Trace represents information about a Resource that can
  30     be collected
  31     """
  32
  33     def __init__(self, name, help, enabled = False):
  34         """
  35         :param name: Name of the Trace
  36         :type name: str
  37
  38         :param help: Description of the Trace
  39         :type help: str
  40
  41         :param enabled: Sets activation state of Trace
  42         :type enabled: bool
  43         """
  44         self._name = name
  45         self._help = help
  46         self.enabled = enabled
  47
  48     @property
  49     def name(self):
  50         """ Returns the name of the trace """
  51         return self._name
  52
  53     @property
  54     def help(self):
  55         """ Returns the help of the trace """
  56         return self._help
  57