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