1 # The MIT License (MIT)
3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
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:
12 # The above copyright notice and this permission notice shall be included in
13 # all copies or substantial portions of the Software.
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
23 from bt2
import native_bt
, object, utils
24 from bt2
import field_class
as bt2_field_class
25 from bt2
import event_class
as bt2_event_class
26 from bt2
import trace_class
as bt2_trace_class
27 from bt2
import clock_class
as bt2_clock_class
28 from bt2
import value
as bt2_value
29 import collections
.abc
32 class _StreamClassConst(object._SharedObject
, collections
.abc
.Mapping
):
33 _get_ref
= staticmethod(native_bt
.stream_class_get_ref
)
34 _put_ref
= staticmethod(native_bt
.stream_class_put_ref
)
35 _borrow_event_class_ptr_by_id
= staticmethod(
36 native_bt
.stream_class_borrow_event_class_by_id_const
38 _borrow_event_class_ptr_by_index
= staticmethod(
39 native_bt
.stream_class_borrow_event_class_by_index_const
41 _borrow_trace_class_ptr
= staticmethod(
42 native_bt
.stream_class_borrow_trace_class_const
44 _borrow_packet_context_field_class_ptr
= staticmethod(
45 native_bt
.stream_class_borrow_packet_context_field_class_const
47 _borrow_event_common_context_field_class_ptr
= staticmethod(
48 native_bt
.stream_class_borrow_event_common_context_field_class_const
50 _borrow_default_clock_class_ptr
= staticmethod(
51 native_bt
.stream_class_borrow_default_clock_class_const
54 _event_class_cls
= property(lambda _
: bt2_event_class
._EventClassConst
)
55 _trace_class_cls
= property(lambda _
: bt2_trace_class
._TraceClassConst
)
56 _clock_class_cls
= property(lambda _
: bt2_clock_class
._ClockClassConst
)
58 def __getitem__(self
, key
):
59 utils
._check
_int
64(key
)
60 ec_ptr
= self
._borrow
_event
_class
_ptr
_by
_id
(self
._ptr
, key
)
65 return self
._event
_class
_cls
._create
_from
_ptr
_and
_get
_ref
(ec_ptr
)
68 count
= native_bt
.stream_class_get_event_class_count(self
._ptr
)
73 for idx
in range(len(self
)):
74 ec_ptr
= self
._borrow
_event
_class
_ptr
_by
_index
(self
._ptr
, idx
)
75 assert ec_ptr
is not None
77 id = native_bt
.event_class_get_id(ec_ptr
)
83 def trace_class(self
):
84 tc_ptr
= self
._borrow
_trace
_class
_ptr
(self
._ptr
)
86 if tc_ptr
is not None:
87 return self
._trace
_class
_cls
._create
_from
_ptr
_and
_get
_ref
(tc_ptr
)
90 def user_attributes(self
):
91 ptr
= native_bt
.stream_class_borrow_user_attributes(self
._ptr
)
92 assert ptr
is not None
93 return bt2_value
._create
_from
_ptr
_and
_get
_ref
(ptr
)
97 return native_bt
.stream_class_get_name(self
._ptr
)
100 def assigns_automatic_event_class_id(self
):
101 return native_bt
.stream_class_assigns_automatic_event_class_id(self
._ptr
)
104 def assigns_automatic_stream_id(self
):
105 return native_bt
.stream_class_assigns_automatic_stream_id(self
._ptr
)
108 def supports_packets(self
):
109 return native_bt
.stream_class_supports_packets(self
._ptr
)
112 def packets_have_beginning_default_clock_snapshot(self
):
113 return native_bt
.stream_class_packets_have_beginning_default_clock_snapshot(
118 def packets_have_end_default_clock_snapshot(self
):
119 return native_bt
.stream_class_packets_have_end_default_clock_snapshot(self
._ptr
)
122 def supports_discarded_events(self
):
123 return native_bt
.stream_class_supports_discarded_events(self
._ptr
)
126 def discarded_events_have_default_clock_snapshots(self
):
127 return native_bt
.stream_class_discarded_events_have_default_clock_snapshots(
132 def supports_discarded_packets(self
):
133 return native_bt
.stream_class_supports_discarded_packets(self
._ptr
)
136 def discarded_packets_have_default_clock_snapshots(self
):
137 return native_bt
.stream_class_discarded_packets_have_default_clock_snapshots(
143 id = native_bt
.stream_class_get_id(self
._ptr
)
151 def packet_context_field_class(self
):
152 fc_ptr
= self
._borrow
_packet
_context
_field
_class
_ptr
(self
._ptr
)
157 return bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(fc_ptr
)
160 def event_common_context_field_class(self
):
161 fc_ptr
= self
._borrow
_event
_common
_context
_field
_class
_ptr
(self
._ptr
)
166 return bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(fc_ptr
)
169 def default_clock_class(self
):
170 cc_ptr
= self
._borrow
_default
_clock
_class
_ptr
(self
._ptr
)
174 return self
._clock
_class
_cls
._create
_from
_ptr
_and
_get
_ref
(cc_ptr
)
177 class _StreamClass(_StreamClassConst
):
178 _get_ref
= staticmethod(native_bt
.stream_class_get_ref
)
179 _put_ref
= staticmethod(native_bt
.stream_class_put_ref
)
180 _borrow_event_class_ptr_by_id
= staticmethod(
181 native_bt
.stream_class_borrow_event_class_by_id
183 _borrow_event_class_ptr_by_index
= staticmethod(
184 native_bt
.stream_class_borrow_event_class_by_index
186 _borrow_trace_class_ptr
= staticmethod(native_bt
.stream_class_borrow_trace_class
)
187 _borrow_packet_context_field_class_ptr
= staticmethod(
188 native_bt
.stream_class_borrow_packet_context_field_class
190 _borrow_event_common_context_field_class_ptr
= staticmethod(
191 native_bt
.stream_class_borrow_event_common_context_field_class
193 _borrow_default_clock_class_ptr
= staticmethod(
194 native_bt
.stream_class_borrow_default_clock_class
196 _event_class_cls
= property(lambda s
: bt2_event_class
._EventClass
)
197 _trace_class_cls
= property(lambda s
: bt2_trace_class
._TraceClass
)
198 _clock_class_cls
= property(lambda s
: bt2_clock_class
._ClockClass
)
200 def create_event_class(
204 user_attributes
=None,
207 specific_context_field_class
=None,
208 payload_field_class
=None,
210 if self
.assigns_automatic_event_class_id
:
213 'id provided, but stream class assigns automatic event class ids'
216 ec_ptr
= native_bt
.event_class_create(self
._ptr
)
220 'id not provided, but stream class does not assign automatic event class ids'
223 utils
._check
_uint
64(id)
224 ec_ptr
= native_bt
.event_class_create_with_id(self
._ptr
, id)
226 event_class
= bt2_event_class
._EventClass
._create
_from
_ptr
(ec_ptr
)
229 event_class
._name
= name
231 if user_attributes
is not None:
232 event_class
._user
_attributes
= user_attributes
234 if log_level
is not None:
235 event_class
._log
_level
= log_level
237 if emf_uri
is not None:
238 event_class
._emf
_uri
= emf_uri
240 if specific_context_field_class
is not None:
241 event_class
._specific
_context
_field
_class
= specific_context_field_class
243 if payload_field_class
is not None:
244 event_class
._payload
_field
_class
= payload_field_class
248 def _user_attributes(self
, user_attributes
):
249 value
= bt2_value
.create_value(user_attributes
)
250 utils
._check
_type
(value
, bt2_value
.MapValue
)
251 native_bt
.stream_class_set_user_attributes(self
._ptr
, value
._ptr
)
253 _user_attributes
= property(fset
=_user_attributes
)
255 def _name(self
, name
):
256 utils
._check
_str
(name
)
257 status
= native_bt
.stream_class_set_name(self
._ptr
, name
)
258 utils
._handle
_func
_status
(status
, "cannot set stream class object's name")
260 _name
= property(fset
=_name
)
262 def _assigns_automatic_event_class_id(self
, auto_id
):
263 utils
._check
_bool
(auto_id
)
264 return native_bt
.stream_class_set_assigns_automatic_event_class_id(
268 _assigns_automatic_event_class_id
= property(fset
=_assigns_automatic_event_class_id
)
270 def _assigns_automatic_stream_id(self
, auto_id
):
271 utils
._check
_bool
(auto_id
)
272 return native_bt
.stream_class_set_assigns_automatic_stream_id(
276 _assigns_automatic_stream_id
= property(fset
=_assigns_automatic_stream_id
)
278 def _set_supports_packets(self
, supports
, with_begin_cs
=False, with_end_cs
=False):
279 utils
._check
_bool
(supports
)
280 utils
._check
_bool
(with_begin_cs
)
281 utils
._check
_bool
(with_end_cs
)
283 if not supports
and (with_begin_cs
or with_end_cs
):
285 'cannot not support packets, but have default clock snapshots'
288 if not supports
and self
.packet_context_field_class
is not None:
289 raise ValueError('stream class already has a packet context field class')
291 native_bt
.stream_class_set_supports_packets(
292 self
._ptr
, supports
, with_begin_cs
, with_end_cs
295 def _set_supports_discarded_events(self
, supports
, with_cs
=False):
296 utils
._check
_bool
(supports
)
297 utils
._check
_bool
(with_cs
)
299 if not supports
and with_cs
:
301 'cannot not support discarded events, but have default clock snapshots'
304 native_bt
.stream_class_set_supports_discarded_events(
305 self
._ptr
, supports
, with_cs
308 _supports_discarded_events
= property(fset
=_set_supports_discarded_events
)
310 def _set_supports_discarded_packets(self
, supports
, with_cs
):
311 utils
._check
_bool
(supports
)
312 utils
._check
_bool
(with_cs
)
314 if supports
and not self
.supports_packets
:
316 'cannot support discarded packets, but not support packets'
319 if not supports
and with_cs
:
321 'cannot not support discarded packets, but have default clock snapshots'
324 native_bt
.stream_class_set_supports_discarded_packets(
325 self
._ptr
, supports
, with_cs
328 _supports_discarded_packets
= property(fset
=_set_supports_discarded_packets
)
330 def _packet_context_field_class(self
, packet_context_field_class
):
331 if packet_context_field_class
is not None:
333 packet_context_field_class
, bt2_field_class
._StructureFieldClass
336 if not self
.supports_packets
:
337 raise ValueError('stream class does not support packets')
339 status
= native_bt
.stream_class_set_packet_context_field_class(
340 self
._ptr
, packet_context_field_class
._ptr
342 utils
._handle
_func
_status
(
343 status
, "cannot set stream class' packet context field class"
346 _packet_context_field_class
= property(fset
=_packet_context_field_class
)
348 def _event_common_context_field_class(self
, event_common_context_field_class
):
349 if event_common_context_field_class
is not None:
351 event_common_context_field_class
, bt2_field_class
._StructureFieldClass
354 set_context_fn
= native_bt
.stream_class_set_event_common_context_field_class
355 status
= set_context_fn(self
._ptr
, event_common_context_field_class
._ptr
)
356 utils
._handle
_func
_status
(
357 status
, "cannot set stream class' event context field type"
360 _event_common_context_field_class
= property(fset
=_event_common_context_field_class
)
362 def _default_clock_class(self
, clock_class
):
363 utils
._check
_type
(clock_class
, bt2_clock_class
._ClockClass
)
364 native_bt
.stream_class_set_default_clock_class(self
._ptr
, clock_class
._ptr
)
366 _default_clock_class
= property(fset
=_default_clock_class
)