src/bindings/python/bt2/bt2/stream.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, utils
  24 from bt2 import object as bt2_object
  25 from bt2 import packet as bt2_packet
  26 from bt2 import trace as bt2_trace
  27 from bt2 import stream_class as bt2_stream_class
  28 from bt2 import value as bt2_value
  29 import bt2
  30
  31
  32 class _Stream(bt2_object._SharedObject):
  33     _get_ref = staticmethod(native_bt.stream_get_ref)
  34     _put_ref = staticmethod(native_bt.stream_put_ref)
  35
  36     @property
  37     def cls(self):
  38         stream_class_ptr = native_bt.stream_borrow_class(self._ptr)
  39         assert stream_class_ptr is not None
  40         return bt2_stream_class._StreamClass._create_from_ptr_and_get_ref(
  41             stream_class_ptr
  42         )
  43
  44     @property
  45     def name(self):
  46         return native_bt.stream_get_name(self._ptr)
  47
  48     def _name(self, name):
  49         utils._check_str(name)
  50         native_bt.stream_set_name(self._ptr, name)
  51
  52     _name = property(fset=_name)
  53
  54     @property
  55     def user_attributes(self):
  56         ptr = native_bt.stream_borrow_user_attributes(self._ptr)
  57         assert ptr is not None
  58         return bt2_value._create_from_ptr_and_get_ref(ptr)
  59
  60     def _user_attributes(self, user_attributes):
  61         value = bt2_value.create_value(user_attributes)
  62         utils._check_type(value, bt2_value.MapValue)
  63         native_bt.stream_set_user_attributes(self._ptr, value._ptr)
  64
  65     _user_attributes = property(fset=_user_attributes)
  66
  67     @property
  68     def id(self):
  69         id = native_bt.stream_get_id(self._ptr)
  70         return id if id >= 0 else None
  71
  72     def create_packet(self):
  73         if not self.cls.supports_packets:
  74             raise ValueError(
  75                 'cannot create packet: stream class does not support packets'
  76             )
  77
  78         packet_ptr = native_bt.packet_create(self._ptr)
  79
  80         if packet_ptr is None:
  81             raise bt2._MemoryError('cannot create packet object')
  82
  83         return bt2_packet._Packet._create_from_ptr(packet_ptr)
  84
  85     @property
  86     def trace(self):
  87         trace_ptr = native_bt.stream_borrow_trace(self._ptr)
  88         assert trace_ptr is not None
  89         return bt2_trace._Trace._create_from_ptr_and_get_ref(trace_ptr)