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 clock_class
as bt2_clock_class
27 from bt2
import value
as bt2_value
28 import collections
.abc
31 def _bt2_trace_class():
32 from bt2
import trace_class
as bt2_trace_class
34 return bt2_trace_class
37 class _StreamClassConst(object._SharedObject
, collections
.abc
.Mapping
):
38 _get_ref
= staticmethod(native_bt
.stream_class_get_ref
)
39 _put_ref
= staticmethod(native_bt
.stream_class_put_ref
)
40 _borrow_event_class_ptr_by_id
= staticmethod(
41 native_bt
.stream_class_borrow_event_class_by_id_const
43 _borrow_event_class_ptr_by_index
= staticmethod(
44 native_bt
.stream_class_borrow_event_class_by_index_const
46 _borrow_trace_class_ptr
= staticmethod(
47 native_bt
.stream_class_borrow_trace_class_const
49 _borrow_packet_context_field_class_ptr
= staticmethod(
50 native_bt
.stream_class_borrow_packet_context_field_class_const
52 _borrow_event_common_context_field_class_ptr
= staticmethod(
53 native_bt
.stream_class_borrow_event_common_context_field_class_const
55 _borrow_default_clock_class_ptr
= staticmethod(
56 native_bt
.stream_class_borrow_default_clock_class_const
58 _borrow_user_attributes_ptr
= staticmethod(
59 native_bt
.stream_class_borrow_user_attributes_const
62 _event_class_cls
= property(lambda _
: bt2_event_class
._EventClassConst
)
63 _trace_class_cls
= property(lambda _
: _bt2_trace_class()._TraceClassConst
)
64 _clock_class_cls
= property(lambda _
: bt2_clock_class
._ClockClassConst
)
66 def __getitem__(self
, key
):
67 utils
._check
_int
64(key
)
68 ec_ptr
= self
._borrow
_event
_class
_ptr
_by
_id
(self
._ptr
, key
)
73 return self
._event
_class
_cls
._create
_from
_ptr
_and
_get
_ref
(ec_ptr
)
76 count
= native_bt
.stream_class_get_event_class_count(self
._ptr
)
81 for idx
in range(len(self
)):
82 ec_ptr
= self
._borrow
_event
_class
_ptr
_by
_index
(self
._ptr
, idx
)
83 assert ec_ptr
is not None
85 id = native_bt
.event_class_get_id(ec_ptr
)
91 def trace_class(self
):
92 tc_ptr
= self
._borrow
_trace
_class
_ptr
(self
._ptr
)
94 if tc_ptr
is not None:
95 return self
._trace
_class
_cls
._create
_from
_ptr
_and
_get
_ref
(tc_ptr
)
98 def user_attributes(self
):
99 ptr
= self
._borrow
_user
_attributes
_ptr
(self
._ptr
)
100 assert ptr
is not None
101 return bt2_value
._create
_from
_ptr
_and
_get
_ref
(ptr
)
105 return native_bt
.stream_class_get_name(self
._ptr
)
108 def assigns_automatic_event_class_id(self
):
109 return native_bt
.stream_class_assigns_automatic_event_class_id(self
._ptr
)
112 def assigns_automatic_stream_id(self
):
113 return native_bt
.stream_class_assigns_automatic_stream_id(self
._ptr
)
116 def supports_packets(self
):
117 return native_bt
.stream_class_supports_packets(self
._ptr
)
120 def packets_have_beginning_default_clock_snapshot(self
):
121 return native_bt
.stream_class_packets_have_beginning_default_clock_snapshot(
126 def packets_have_end_default_clock_snapshot(self
):
127 return native_bt
.stream_class_packets_have_end_default_clock_snapshot(self
._ptr
)
130 def supports_discarded_events(self
):
131 return native_bt
.stream_class_supports_discarded_events(self
._ptr
)
134 def discarded_events_have_default_clock_snapshots(self
):
135 return native_bt
.stream_class_discarded_events_have_default_clock_snapshots(
140 def supports_discarded_packets(self
):
141 return native_bt
.stream_class_supports_discarded_packets(self
._ptr
)
144 def discarded_packets_have_default_clock_snapshots(self
):
145 return native_bt
.stream_class_discarded_packets_have_default_clock_snapshots(
151 id = native_bt
.stream_class_get_id(self
._ptr
)
159 def packet_context_field_class(self
):
160 fc_ptr
= self
._borrow
_packet
_context
_field
_class
_ptr
(self
._ptr
)
165 return bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(fc_ptr
)
168 def event_common_context_field_class(self
):
169 fc_ptr
= self
._borrow
_event
_common
_context
_field
_class
_ptr
(self
._ptr
)
174 return bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(fc_ptr
)
177 def default_clock_class(self
):
178 cc_ptr
= self
._borrow
_default
_clock
_class
_ptr
(self
._ptr
)
182 return self
._clock
_class
_cls
._create
_from
_ptr
_and
_get
_ref
(cc_ptr
)
185 class _StreamClass(_StreamClassConst
):
186 _get_ref
= staticmethod(native_bt
.stream_class_get_ref
)
187 _put_ref
= staticmethod(native_bt
.stream_class_put_ref
)
188 _borrow_event_class_ptr_by_id
= staticmethod(
189 native_bt
.stream_class_borrow_event_class_by_id
191 _borrow_event_class_ptr_by_index
= staticmethod(
192 native_bt
.stream_class_borrow_event_class_by_index
194 _borrow_trace_class_ptr
= staticmethod(native_bt
.stream_class_borrow_trace_class
)
195 _borrow_packet_context_field_class_ptr
= staticmethod(
196 native_bt
.stream_class_borrow_packet_context_field_class
198 _borrow_event_common_context_field_class_ptr
= staticmethod(
199 native_bt
.stream_class_borrow_event_common_context_field_class
201 _borrow_default_clock_class_ptr
= staticmethod(
202 native_bt
.stream_class_borrow_default_clock_class
204 _borrow_user_attributes_ptr
= staticmethod(
205 native_bt
.stream_class_borrow_user_attributes
208 _event_class_cls
= property(lambda s
: bt2_event_class
._EventClass
)
209 _trace_class_cls
= property(lambda s
: _bt2_trace_class()._TraceClass
)
210 _clock_class_cls
= property(lambda s
: bt2_clock_class
._ClockClass
)
212 def create_event_class(
216 user_attributes
=None,
219 specific_context_field_class
=None,
220 payload_field_class
=None,
222 # Validate parameters before we create the object.
223 bt2_event_class
._EventClass
._validate
_create
_params
(
228 specific_context_field_class
,
232 if self
.assigns_automatic_event_class_id
:
235 'id provided, but stream class assigns automatic event class ids'
238 ec_ptr
= native_bt
.event_class_create(self
._ptr
)
242 'id not provided, but stream class does not assign automatic event class ids'
245 utils
._check
_uint
64(id)
246 ec_ptr
= native_bt
.event_class_create_with_id(self
._ptr
, id)
248 event_class
= bt2_event_class
._EventClass
._create
_from
_ptr
(ec_ptr
)
251 event_class
._name
= name
253 if user_attributes
is not None:
254 event_class
._user
_attributes
= user_attributes
256 if log_level
is not None:
257 event_class
._log
_level
= log_level
259 if emf_uri
is not None:
260 event_class
._emf
_uri
= emf_uri
262 if specific_context_field_class
is not None:
263 event_class
._specific
_context
_field
_class
= specific_context_field_class
265 if payload_field_class
is not None:
266 event_class
._payload
_field
_class
= payload_field_class
270 def _user_attributes(self
, user_attributes
):
271 value
= bt2_value
.create_value(user_attributes
)
272 native_bt
.stream_class_set_user_attributes(self
._ptr
, value
._ptr
)
274 _user_attributes
= property(fset
=_user_attributes
)
276 def _name(self
, name
):
277 status
= native_bt
.stream_class_set_name(self
._ptr
, name
)
278 utils
._handle
_func
_status
(status
, "cannot set stream class object's name")
280 _name
= property(fset
=_name
)
282 def _assigns_automatic_event_class_id(self
, auto_id
):
283 native_bt
.stream_class_set_assigns_automatic_event_class_id(self
._ptr
, auto_id
)
285 _assigns_automatic_event_class_id
= property(fset
=_assigns_automatic_event_class_id
)
287 def _assigns_automatic_stream_id(self
, auto_id
):
288 native_bt
.stream_class_set_assigns_automatic_stream_id(self
._ptr
, auto_id
)
290 _assigns_automatic_stream_id
= property(fset
=_assigns_automatic_stream_id
)
292 def _set_supports_packets(self
, supports
, with_begin_cs
=False, with_end_cs
=False):
293 native_bt
.stream_class_set_supports_packets(
294 self
._ptr
, supports
, with_begin_cs
, with_end_cs
297 def _set_supports_discarded_events(self
, supports
, with_cs
=False):
298 native_bt
.stream_class_set_supports_discarded_events(
299 self
._ptr
, supports
, with_cs
302 _supports_discarded_events
= property(fset
=_set_supports_discarded_events
)
304 def _set_supports_discarded_packets(self
, supports
, with_cs
):
305 native_bt
.stream_class_set_supports_discarded_packets(
306 self
._ptr
, supports
, with_cs
309 _supports_discarded_packets
= property(fset
=_set_supports_discarded_packets
)
311 def _packet_context_field_class(self
, packet_context_field_class
):
312 status
= native_bt
.stream_class_set_packet_context_field_class(
313 self
._ptr
, packet_context_field_class
._ptr
315 utils
._handle
_func
_status
(
316 status
, "cannot set stream class' packet context field class"
319 _packet_context_field_class
= property(fset
=_packet_context_field_class
)
321 def _event_common_context_field_class(self
, event_common_context_field_class
):
322 set_context_fn
= native_bt
.stream_class_set_event_common_context_field_class
323 status
= set_context_fn(self
._ptr
, event_common_context_field_class
._ptr
)
324 utils
._handle
_func
_status
(
325 status
, "cannot set stream class' event context field type"
328 _event_common_context_field_class
= property(fset
=_event_common_context_field_class
)
330 def _default_clock_class(self
, clock_class
):
331 native_bt
.stream_class_set_default_clock_class(self
._ptr
, clock_class
._ptr
)
333 _default_clock_class
= property(fset
=_default_clock_class
)
336 def _validate_create_params(
340 packet_context_field_class
,
341 event_common_context_field_class
,
343 assigns_automatic_event_class_id
,
344 assigns_automatic_stream_id
,
346 packets_have_beginning_default_clock_snapshot
,
347 packets_have_end_default_clock_snapshot
,
348 supports_discarded_events
,
349 discarded_events_have_default_clock_snapshots
,
350 supports_discarded_packets
,
351 discarded_packets_have_default_clock_snapshots
,
355 utils
._check
_str
(name
)
358 if user_attributes
is not None:
359 value
= bt2_value
.create_value(user_attributes
)
360 utils
._check
_type
(value
, bt2_value
.MapValue
)
362 # Packet context field class
363 if packet_context_field_class
is not None:
364 if not supports_packets
:
366 'cannot have a packet context field class without supporting packets'
370 packet_context_field_class
, bt2_field_class
._StructureFieldClass
373 # Event common context field class
374 if event_common_context_field_class
is not None:
376 event_common_context_field_class
, bt2_field_class
._StructureFieldClass
379 # Default clock class
380 if default_clock_class
is not None:
381 utils
._check
_type
(default_clock_class
, bt2_clock_class
._ClockClass
)
383 # Assigns automatic event class id
384 utils
._check
_bool
(assigns_automatic_event_class_id
)
386 # Assigns automatic stream id
387 utils
._check
_bool
(assigns_automatic_stream_id
)
390 utils
._check
_bool
(supports_packets
)
391 utils
._check
_bool
(packets_have_beginning_default_clock_snapshot
)
392 utils
._check
_bool
(packets_have_end_default_clock_snapshot
)
394 if not supports_packets
:
395 if packets_have_beginning_default_clock_snapshot
:
397 'cannot not support packets, but have packet beginning default clock snapshot'
399 if packets_have_end_default_clock_snapshot
:
401 'cannot not support packets, but have packet end default clock snapshots'
405 utils
._check
_bool
(supports_discarded_events
)
406 utils
._check
_bool
(discarded_events_have_default_clock_snapshots
)
409 not supports_discarded_events
410 and discarded_events_have_default_clock_snapshots
413 'cannot not support discarded events, but have default clock snapshots for discarded event messages'
417 utils
._check
_bool
(supports_discarded_packets
)
418 utils
._check
_bool
(discarded_packets_have_default_clock_snapshots
)
420 if supports_discarded_packets
and not supports_packets
:
422 'cannot support discarded packets, but not support packets'
426 not supports_discarded_packets
427 and discarded_packets_have_default_clock_snapshots
430 'cannot not support discarded packets, but have default clock snapshots for discarded packet messages'