src/bindings/python/bt2/bt2/event_class.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining a copy
   6 # of this software and associated documentation files (the "Software"), to deal
   7 # in the Software without restriction, including without limitation the rights
   8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 # copies of the Software, and to permit persons to whom the Software is
  10 # furnished to do so, subject to the following conditions:
  11 #
  12 # The above copyright notice and this permission notice shall be included in
  13 # all copies or substantial portions of the Software.
  14 #
  15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 # THE SOFTWARE.
  22
  23 from bt2 import native_bt, object, utils
  24 import bt2.field_class
  25 import bt2.value
  26 import bt2.event
  27 import bt2
  28
  29
  30 class EventClassLogLevel:
  31     EMERGENCY = native_bt.EVENT_CLASS_LOG_LEVEL_EMERGENCY
  32     ALERT = native_bt.EVENT_CLASS_LOG_LEVEL_ALERT
  33     CRITICAL = native_bt.EVENT_CLASS_LOG_LEVEL_CRITICAL
  34     ERROR = native_bt.EVENT_CLASS_LOG_LEVEL_ERROR
  35     WARNING = native_bt.EVENT_CLASS_LOG_LEVEL_WARNING
  36     NOTICE = native_bt.EVENT_CLASS_LOG_LEVEL_NOTICE
  37     INFO = native_bt.EVENT_CLASS_LOG_LEVEL_INFO
  38     DEBUG_SYSTEM = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM
  39     DEBUG_PROGRAM = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM
  40     DEBUG_PROCESS = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS
  41     DEBUG_MODULE = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE
  42     DEBUG_UNIT = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT
  43     DEBUG_FUNCTION = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION
  44     DEBUG_LINE = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_LINE
  45     DEBUG = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG
  46
  47
  48 class _EventClass(object._SharedObject):
  49     _get_ref = staticmethod(native_bt.event_class_get_ref)
  50     _put_ref = staticmethod(native_bt.event_class_put_ref)
  51
  52     @property
  53     def stream_class(self):
  54         sc_ptr = native_bt.event_class_borrow_stream_class(self._ptr)
  55
  56         if sc_ptr is not None:
  57             return bt2.stream_class._StreamClass._create_from_ptr_and_get_ref(sc_ptr)
  58
  59     @property
  60     def name(self):
  61         return native_bt.event_class_get_name(self._ptr)
  62
  63     def _name(self, name):
  64         utils._check_str(name)
  65         return native_bt.event_class_set_name(self._ptr, name)
  66
  67     _name = property(fset=_name)
  68
  69     @property
  70     def id(self):
  71         id = native_bt.event_class_get_id(self._ptr)
  72         return id if id >= 0 else None
  73
  74     @property
  75     def log_level(self):
  76         is_available, log_level = native_bt.event_class_get_log_level(self._ptr)
  77
  78         if is_available != native_bt.PROPERTY_AVAILABILITY_AVAILABLE:
  79             return None
  80
  81         return _EVENT_CLASS_LOG_LEVEL_TO_OBJ[log_level]
  82
  83     def _log_level(self, log_level):
  84         log_levels = (
  85             EventClassLogLevel.EMERGENCY,
  86             EventClassLogLevel.ALERT,
  87             EventClassLogLevel.CRITICAL,
  88             EventClassLogLevel.ERROR,
  89             EventClassLogLevel.WARNING,
  90             EventClassLogLevel.NOTICE,
  91             EventClassLogLevel.INFO,
  92             EventClassLogLevel.DEBUG_SYSTEM,
  93             EventClassLogLevel.DEBUG_PROGRAM,
  94             EventClassLogLevel.DEBUG_PROCESS,
  95             EventClassLogLevel.DEBUG_MODULE,
  96             EventClassLogLevel.DEBUG_UNIT,
  97             EventClassLogLevel.DEBUG_FUNCTION,
  98             EventClassLogLevel.DEBUG_LINE,
  99             EventClassLogLevel.DEBUG,
 100         )
 101
 102         if log_level not in log_levels:
 103             raise ValueError("'{}' is not a valid log level".format(log_level))
 104
 105         native_bt.event_class_set_log_level(self._ptr, log_level)
 106
 107     _log_level = property(fset=_log_level)
 108
 109     @property
 110     def emf_uri(self):
 111         return native_bt.event_class_get_emf_uri(self._ptr)
 112
 113     def _emf_uri(self, emf_uri):
 114         utils._check_str(emf_uri)
 115         status = native_bt.event_class_set_emf_uri(self._ptr, emf_uri)
 116         utils._handle_func_status(status,
 117                                   "cannot set event class object's EMF URI")
 118
 119     _emf_uri = property(fset=_emf_uri)
 120
 121     @property
 122     def specific_context_field_class(self):
 123         fc_ptr = native_bt.event_class_borrow_specific_context_field_class_const(self._ptr)
 124
 125         if fc_ptr is None:
 126             return
 127
 128         return bt2.field_class._create_field_class_from_ptr_and_get_ref(fc_ptr)
 129
 130     def _specific_context_field_class(self, context_field_class):
 131         if context_field_class is not None:
 132             utils._check_type(context_field_class, bt2.field_class._StructureFieldClass)
 133             status = native_bt.event_class_set_specific_context_field_class(self._ptr, context_field_class._ptr)
 134             utils._handle_func_status(status,
 135                                       "cannot set event class object's context field class")
 136
 137     _specific_context_field_class = property(fset=_specific_context_field_class)
 138
 139     @property
 140     def payload_field_class(self):
 141         fc_ptr = native_bt.event_class_borrow_payload_field_class_const(self._ptr)
 142
 143         if fc_ptr is None:
 144             return
 145
 146         return bt2.field_class._create_field_class_from_ptr_and_get_ref(fc_ptr)
 147
 148     def _payload_field_class(self, payload_field_class):
 149         if payload_field_class is not None:
 150             utils._check_type(payload_field_class, bt2.field_class._StructureFieldClass)
 151             status = native_bt.event_class_set_payload_field_class(self._ptr, payload_field_class._ptr)
 152             utils._handle_func_status(status,
 153                                       "cannot set event class object's payload field class")
 154
 155     _payload_field_class = property(fset=_payload_field_class)
 156
 157
 158 _EVENT_CLASS_LOG_LEVEL_TO_OBJ = {
 159     native_bt.EVENT_CLASS_LOG_LEVEL_EMERGENCY: EventClassLogLevel.EMERGENCY,
 160     native_bt.EVENT_CLASS_LOG_LEVEL_ALERT: EventClassLogLevel.ALERT,
 161     native_bt.EVENT_CLASS_LOG_LEVEL_CRITICAL: EventClassLogLevel.CRITICAL,
 162     native_bt.EVENT_CLASS_LOG_LEVEL_ERROR: EventClassLogLevel.ERROR,
 163     native_bt.EVENT_CLASS_LOG_LEVEL_WARNING: EventClassLogLevel.WARNING,
 164     native_bt.EVENT_CLASS_LOG_LEVEL_NOTICE: EventClassLogLevel.NOTICE,
 165     native_bt.EVENT_CLASS_LOG_LEVEL_INFO: EventClassLogLevel.INFO,
 166     native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM: EventClassLogLevel.DEBUG_SYSTEM,
 167     native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM: EventClassLogLevel.DEBUG_PROGRAM,
 168     native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS: EventClassLogLevel.DEBUG_PROCESS,
 169     native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE: EventClassLogLevel.DEBUG_MODULE,
 170     native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT: EventClassLogLevel.DEBUG_UNIT,
 171     native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION: EventClassLogLevel.DEBUG_FUNCTION,
 172     native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG_LINE: EventClassLogLevel.DEBUG_LINE,
 173     native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG: EventClassLogLevel.DEBUG,
 174 }