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