bindings/python/bt2/bt2/event.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (c) 2016-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.clock_class
  25 import bt2.event_class
  26 import bt2.packet
  27 import bt2.stream
  28 import bt2.field
  29 import bt2.clock_snapshot
  30 import bt2
  31
  32
  33 class _Event(object._UniqueObject):
  34     @property
  35     def event_class(self):
  36         event_class_ptr = native_bt.event_borrow_class(self._ptr)
  37         assert event_class_ptr is not None
  38         return bt2.event_class._EventClass._create_from_ptr_and_get_ref(event_class_ptr)
  39
  40     @property
  41     def name(self):
  42         return self.event_class.name
  43
  44     @property
  45     def id(self):
  46         return self.event_class.id
  47
  48     @property
  49     def packet(self):
  50         packet_ptr = native_bt.event_borrow_packet(self._ptr)
  51         assert packet_ptr is not None
  52         return bt2.packet._Packet._create_from_ptr_and_get_ref(packet_ptr)
  53
  54     @property
  55     def stream(self):
  56         stream_ptr = native_bt.event_borrow_stream(self._ptr)
  57         assert stream_ptr is not None
  58         return bt2._Stream._create_from_ptr_and_get_ref(stream_ptr)
  59
  60     @property
  61     def common_context_field(self):
  62         field_ptr = native_bt.event_borrow_common_context_field(self._ptr)
  63
  64         if field_ptr is None:
  65             return
  66
  67         return bt2.field._create_field_from_ptr(field_ptr, self._owner_ptr,
  68                                                 self._owner_get_ref,
  69                                                 self._owner_put_ref)
  70
  71     @property
  72     def specific_context_field(self):
  73         field_ptr = native_bt.event_borrow_specific_context_field(self._ptr)
  74
  75         if field_ptr is None:
  76             return
  77
  78         return bt2.field._create_field_from_ptr(field_ptr, self._owner_ptr,
  79                                                 self._owner_get_ref,
  80                                                 self._owner_put_ref)
  81
  82     @property
  83     def payload_field(self):
  84         field_ptr = native_bt.event_borrow_payload_field(self._ptr)
  85
  86         if field_ptr is None:
  87             return
  88
  89         return bt2.field._create_field_from_ptr(field_ptr, self._owner_ptr,
  90                                                 self._owner_get_ref,
  91                                                 self._owner_put_ref)
  92
  93     def __getitem__(self, key):
  94         utils._check_str(key)
  95         payload_field = self.payload_field
  96
  97         if payload_field is not None and key in payload_field:
  98             return payload_field[key]
  99
 100         specific_context_field = self.specific_context_field
 101
 102         if specific_context_field is not None and key in specific_context_field:
 103             return specific_context_field[key]
 104
 105         common_context_field = self.common_context_field
 106
 107         if common_context_field is not None and key in common_context_field:
 108             return common_context_field[key]
 109
 110         packet_context_field = self.packet.context_field
 111
 112         if packet_context_field is not None and key in packet_context_field:
 113             return packet_context_field[key]
 114
 115         raise KeyError(key)