Update project plugins's properties
[babeltrace.git] / 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 _StreamConst(bt2_object._SharedObject):
33 _get_ref = staticmethod(native_bt.stream_get_ref)
34 _put_ref = staticmethod(native_bt.stream_put_ref)
35 _borrow_class_ptr = staticmethod(native_bt.stream_borrow_class_const)
36 _borrow_user_attributes_ptr = staticmethod(
37 native_bt.stream_borrow_user_attributes_const
38 )
39 _create_value_from_ptr_and_get_ref = staticmethod(
40 bt2_value._create_from_const_ptr_and_get_ref
41 )
42 _borrow_trace_ptr = staticmethod(native_bt.stream_borrow_trace_const)
43 _stream_class_pycls = bt2_stream_class._StreamClassConst
44 _trace_pycls = bt2_trace._TraceConst
45
46 @property
47 def cls(self):
48 stream_class_ptr = self._borrow_class_ptr(self._ptr)
49 assert stream_class_ptr is not None
50 return self._stream_class_pycls._create_from_ptr_and_get_ref(stream_class_ptr)
51
52 @property
53 def name(self):
54 return native_bt.stream_get_name(self._ptr)
55
56 @property
57 def user_attributes(self):
58 ptr = self._borrow_user_attributes_ptr(self._ptr)
59 assert ptr is not None
60 return self._create_value_from_ptr_and_get_ref(ptr)
61
62 @property
63 def id(self):
64 id = native_bt.stream_get_id(self._ptr)
65 return id if id >= 0 else None
66
67 @property
68 def trace(self):
69 trace_ptr = self._borrow_trace_ptr(self._ptr)
70 assert trace_ptr is not None
71 return self._trace_pycls._create_from_ptr_and_get_ref(trace_ptr)
72
73
74 class _Stream(_StreamConst):
75 _borrow_class_ptr = staticmethod(native_bt.stream_borrow_class)
76 _borrow_user_attributes_ptr = staticmethod(native_bt.stream_borrow_user_attributes)
77 _create_value_from_ptr_and_get_ref = staticmethod(
78 bt2_value._create_from_ptr_and_get_ref
79 )
80 _borrow_trace_ptr = staticmethod(native_bt.stream_borrow_trace)
81 _stream_class_pycls = bt2_stream_class._StreamClass
82 _trace_pycls = bt2_trace._Trace
83
84 def create_packet(self):
85 if not self.cls.supports_packets:
86 raise ValueError(
87 'cannot create packet: stream class does not support packets'
88 )
89
90 packet_ptr = native_bt.packet_create(self._ptr)
91
92 if packet_ptr is None:
93 raise bt2._MemoryError('cannot create packet object')
94
95 return bt2_packet._Packet._create_from_ptr(packet_ptr)
96
97 def _user_attributes(self, user_attributes):
98 value = bt2_value.create_value(user_attributes)
99 utils._check_type(value, bt2_value.MapValue)
100 native_bt.stream_set_user_attributes(self._ptr, value._ptr)
101
102 _user_attributes = property(
103 fget=_StreamConst.user_attributes.fget, fset=_user_attributes
104 )
105
106 def _name(self, name):
107 utils._check_str(name)
108 native_bt.stream_set_name(self._ptr, name)
109
110 _name = property(fget=_StreamConst.name.fget, fset=_name)
This page took 0.031314 seconds and 4 git commands to generate.