Commit | Line | Data |
---|---|---|
81447b5b PP |
1 | # The MIT License (MIT) |
2 | # | |
f6a5e476 | 3 | # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com> |
81447b5b PP |
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 | |
c946c9de PP |
24 | from bt2 import field_class as bt2_field_class |
25 | from bt2 import event_class as bt2_event_class | |
c946c9de | 26 | from bt2 import clock_class as bt2_clock_class |
b2df5780 | 27 | from bt2 import value as bt2_value |
81447b5b | 28 | import collections.abc |
81447b5b PP |
29 | |
30 | ||
7868a02e SM |
31 | def _bt2_trace_class(): |
32 | from bt2 import trace_class as bt2_trace_class | |
33 | ||
34 | return bt2_trace_class | |
35 | ||
36 | ||
9cbe0c59 | 37 | class _StreamClassConst(object._SharedObject, collections.abc.Mapping): |
0bee8ea9 SM |
38 | _get_ref = staticmethod(native_bt.stream_class_get_ref) |
39 | _put_ref = staticmethod(native_bt.stream_class_put_ref) | |
9cbe0c59 FD |
40 | _borrow_event_class_ptr_by_id = staticmethod( |
41 | native_bt.stream_class_borrow_event_class_by_id_const | |
42 | ) | |
43 | _borrow_event_class_ptr_by_index = staticmethod( | |
44 | native_bt.stream_class_borrow_event_class_by_index_const | |
45 | ) | |
46 | _borrow_trace_class_ptr = staticmethod( | |
47 | native_bt.stream_class_borrow_trace_class_const | |
48 | ) | |
49 | _borrow_packet_context_field_class_ptr = staticmethod( | |
50 | native_bt.stream_class_borrow_packet_context_field_class_const | |
51 | ) | |
52 | _borrow_event_common_context_field_class_ptr = staticmethod( | |
53 | native_bt.stream_class_borrow_event_common_context_field_class_const | |
54 | ) | |
55 | _borrow_default_clock_class_ptr = staticmethod( | |
56 | native_bt.stream_class_borrow_default_clock_class_const | |
57 | ) | |
a6f93683 SM |
58 | _borrow_user_attributes_ptr = staticmethod( |
59 | native_bt.stream_class_borrow_user_attributes_const | |
60 | ) | |
9cbe0c59 FD |
61 | |
62 | _event_class_cls = property(lambda _: bt2_event_class._EventClassConst) | |
7868a02e | 63 | _trace_class_cls = property(lambda _: _bt2_trace_class()._TraceClassConst) |
9cbe0c59 | 64 | _clock_class_cls = property(lambda _: bt2_clock_class._ClockClassConst) |
0bee8ea9 | 65 | |
81447b5b | 66 | def __getitem__(self, key): |
f6a5e476 | 67 | utils._check_int64(key) |
9cbe0c59 | 68 | ec_ptr = self._borrow_event_class_ptr_by_id(self._ptr, key) |
81447b5b PP |
69 | |
70 | if ec_ptr is None: | |
71 | raise KeyError(key) | |
72 | ||
9cbe0c59 | 73 | return self._event_class_cls._create_from_ptr_and_get_ref(ec_ptr) |
81447b5b PP |
74 | |
75 | def __len__(self): | |
839d52a5 | 76 | count = native_bt.stream_class_get_event_class_count(self._ptr) |
060aee52 | 77 | assert count >= 0 |
81447b5b PP |
78 | return count |
79 | ||
80 | def __iter__(self): | |
060aee52 | 81 | for idx in range(len(self)): |
9cbe0c59 | 82 | ec_ptr = self._borrow_event_class_ptr_by_index(self._ptr, idx) |
060aee52 SM |
83 | assert ec_ptr is not None |
84 | ||
85 | id = native_bt.event_class_get_id(ec_ptr) | |
86 | assert id >= 0 | |
87 | ||
88 | yield id | |
81447b5b | 89 | |
9cbe0c59 FD |
90 | @property |
91 | def trace_class(self): | |
92 | tc_ptr = self._borrow_trace_class_ptr(self._ptr) | |
93 | ||
94 | if tc_ptr is not None: | |
95 | return self._trace_class_cls._create_from_ptr_and_get_ref(tc_ptr) | |
96 | ||
97 | @property | |
98 | def user_attributes(self): | |
a6f93683 | 99 | ptr = self._borrow_user_attributes_ptr(self._ptr) |
9cbe0c59 FD |
100 | assert ptr is not None |
101 | return bt2_value._create_from_ptr_and_get_ref(ptr) | |
102 | ||
103 | @property | |
104 | def name(self): | |
105 | return native_bt.stream_class_get_name(self._ptr) | |
106 | ||
107 | @property | |
108 | def assigns_automatic_event_class_id(self): | |
109 | return native_bt.stream_class_assigns_automatic_event_class_id(self._ptr) | |
110 | ||
111 | @property | |
112 | def assigns_automatic_stream_id(self): | |
113 | return native_bt.stream_class_assigns_automatic_stream_id(self._ptr) | |
114 | ||
115 | @property | |
116 | def supports_packets(self): | |
117 | return native_bt.stream_class_supports_packets(self._ptr) | |
118 | ||
119 | @property | |
120 | def packets_have_beginning_default_clock_snapshot(self): | |
121 | return native_bt.stream_class_packets_have_beginning_default_clock_snapshot( | |
122 | self._ptr | |
123 | ) | |
124 | ||
125 | @property | |
126 | def packets_have_end_default_clock_snapshot(self): | |
127 | return native_bt.stream_class_packets_have_end_default_clock_snapshot(self._ptr) | |
128 | ||
129 | @property | |
130 | def supports_discarded_events(self): | |
131 | return native_bt.stream_class_supports_discarded_events(self._ptr) | |
132 | ||
133 | @property | |
134 | def discarded_events_have_default_clock_snapshots(self): | |
135 | return native_bt.stream_class_discarded_events_have_default_clock_snapshots( | |
136 | self._ptr | |
137 | ) | |
138 | ||
139 | @property | |
140 | def supports_discarded_packets(self): | |
141 | return native_bt.stream_class_supports_discarded_packets(self._ptr) | |
142 | ||
143 | @property | |
144 | def discarded_packets_have_default_clock_snapshots(self): | |
145 | return native_bt.stream_class_discarded_packets_have_default_clock_snapshots( | |
146 | self._ptr | |
147 | ) | |
148 | ||
149 | @property | |
150 | def id(self): | |
151 | id = native_bt.stream_class_get_id(self._ptr) | |
152 | ||
153 | if id < 0: | |
154 | return | |
155 | ||
156 | return id | |
157 | ||
158 | @property | |
159 | def packet_context_field_class(self): | |
160 | fc_ptr = self._borrow_packet_context_field_class_ptr(self._ptr) | |
161 | ||
162 | if fc_ptr is None: | |
163 | return | |
164 | ||
165 | return bt2_field_class._create_field_class_from_ptr_and_get_ref(fc_ptr) | |
166 | ||
167 | @property | |
168 | def event_common_context_field_class(self): | |
169 | fc_ptr = self._borrow_event_common_context_field_class_ptr(self._ptr) | |
170 | ||
171 | if fc_ptr is None: | |
172 | return | |
173 | ||
174 | return bt2_field_class._create_field_class_from_ptr_and_get_ref(fc_ptr) | |
175 | ||
176 | @property | |
177 | def default_clock_class(self): | |
178 | cc_ptr = self._borrow_default_clock_class_ptr(self._ptr) | |
179 | if cc_ptr is None: | |
180 | return | |
181 | ||
182 | return self._clock_class_cls._create_from_ptr_and_get_ref(cc_ptr) | |
183 | ||
184 | ||
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 | |
190 | ) | |
191 | _borrow_event_class_ptr_by_index = staticmethod( | |
192 | native_bt.stream_class_borrow_event_class_by_index | |
193 | ) | |
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 | |
197 | ) | |
198 | _borrow_event_common_context_field_class_ptr = staticmethod( | |
199 | native_bt.stream_class_borrow_event_common_context_field_class | |
200 | ) | |
201 | _borrow_default_clock_class_ptr = staticmethod( | |
202 | native_bt.stream_class_borrow_default_clock_class | |
203 | ) | |
a6f93683 SM |
204 | _borrow_user_attributes_ptr = staticmethod( |
205 | native_bt.stream_class_borrow_user_attributes | |
206 | ) | |
207 | ||
9cbe0c59 | 208 | _event_class_cls = property(lambda s: bt2_event_class._EventClass) |
7868a02e | 209 | _trace_class_cls = property(lambda s: _bt2_trace_class()._TraceClass) |
9cbe0c59 FD |
210 | _clock_class_cls = property(lambda s: bt2_clock_class._ClockClass) |
211 | ||
61d96b89 FD |
212 | def create_event_class( |
213 | self, | |
214 | id=None, | |
215 | name=None, | |
b2df5780 | 216 | user_attributes=None, |
61d96b89 FD |
217 | log_level=None, |
218 | emf_uri=None, | |
219 | specific_context_field_class=None, | |
220 | payload_field_class=None, | |
221 | ): | |
88cf5343 SM |
222 | # Validate parameters before we create the object. |
223 | bt2_event_class._EventClass._validate_create_params( | |
224 | name, | |
225 | user_attributes, | |
226 | log_level, | |
227 | emf_uri, | |
228 | specific_context_field_class, | |
229 | payload_field_class, | |
230 | ) | |
231 | ||
060aee52 SM |
232 | if self.assigns_automatic_event_class_id: |
233 | if id is not None: | |
61d96b89 FD |
234 | raise ValueError( |
235 | 'id provided, but stream class assigns automatic event class ids' | |
236 | ) | |
060aee52 SM |
237 | |
238 | ec_ptr = native_bt.event_class_create(self._ptr) | |
239 | else: | |
240 | if id is None: | |
61d96b89 FD |
241 | raise ValueError( |
242 | 'id not provided, but stream class does not assign automatic event class ids' | |
243 | ) | |
060aee52 SM |
244 | |
245 | utils._check_uint64(id) | |
246 | ec_ptr = native_bt.event_class_create_with_id(self._ptr, id) | |
247 | ||
c946c9de | 248 | event_class = bt2_event_class._EventClass._create_from_ptr(ec_ptr) |
a728f6c3 SM |
249 | |
250 | if name is not None: | |
251 | event_class._name = name | |
252 | ||
b2df5780 PP |
253 | if user_attributes is not None: |
254 | event_class._user_attributes = user_attributes | |
255 | ||
a728f6c3 SM |
256 | if log_level is not None: |
257 | event_class._log_level = log_level | |
258 | ||
259 | if emf_uri is not None: | |
260 | event_class._emf_uri = emf_uri | |
261 | ||
262 | if specific_context_field_class is not None: | |
263 | event_class._specific_context_field_class = specific_context_field_class | |
264 | ||
265 | if payload_field_class is not None: | |
266 | event_class._payload_field_class = payload_field_class | |
267 | ||
268 | return event_class | |
81447b5b | 269 | |
b2df5780 PP |
270 | def _user_attributes(self, user_attributes): |
271 | value = bt2_value.create_value(user_attributes) | |
b2df5780 PP |
272 | native_bt.stream_class_set_user_attributes(self._ptr, value._ptr) |
273 | ||
274 | _user_attributes = property(fset=_user_attributes) | |
275 | ||
060aee52 | 276 | def _name(self, name): |
fb25b9e3 | 277 | status = native_bt.stream_class_set_name(self._ptr, name) |
61d96b89 | 278 | utils._handle_func_status(status, "cannot set stream class object's name") |
81447b5b | 279 | |
060aee52 SM |
280 | _name = property(fset=_name) |
281 | ||
060aee52 | 282 | def _assigns_automatic_event_class_id(self, auto_id): |
a373e036 | 283 | native_bt.stream_class_set_assigns_automatic_event_class_id(self._ptr, auto_id) |
060aee52 SM |
284 | |
285 | _assigns_automatic_event_class_id = property(fset=_assigns_automatic_event_class_id) | |
286 | ||
f377a958 | 287 | def _assigns_automatic_stream_id(self, auto_id): |
a373e036 | 288 | native_bt.stream_class_set_assigns_automatic_stream_id(self._ptr, auto_id) |
f377a958 SM |
289 | |
290 | _assigns_automatic_stream_id = property(fset=_assigns_automatic_stream_id) | |
291 | ||
37a93d41 | 292 | def _set_supports_packets(self, supports, with_begin_cs=False, with_end_cs=False): |
61d96b89 FD |
293 | native_bt.stream_class_set_supports_packets( |
294 | self._ptr, supports, with_begin_cs, with_end_cs | |
295 | ) | |
060aee52 | 296 | |
77037b2b | 297 | def _set_supports_discarded_events(self, supports, with_cs=False): |
61d96b89 FD |
298 | native_bt.stream_class_set_supports_discarded_events( |
299 | self._ptr, supports, with_cs | |
300 | ) | |
77037b2b | 301 | |
9cbe0c59 | 302 | _supports_discarded_events = property(fset=_set_supports_discarded_events) |
77037b2b PP |
303 | |
304 | def _set_supports_discarded_packets(self, supports, with_cs): | |
61d96b89 FD |
305 | native_bt.stream_class_set_supports_discarded_packets( |
306 | self._ptr, supports, with_cs | |
307 | ) | |
77037b2b | 308 | |
9cbe0c59 | 309 | _supports_discarded_packets = property(fset=_set_supports_discarded_packets) |
81447b5b | 310 | |
060aee52 | 311 | def _packet_context_field_class(self, packet_context_field_class): |
a373e036 SM |
312 | status = native_bt.stream_class_set_packet_context_field_class( |
313 | self._ptr, packet_context_field_class._ptr | |
314 | ) | |
315 | utils._handle_func_status( | |
316 | status, "cannot set stream class' packet context field class" | |
317 | ) | |
318 | ||
319 | _packet_context_field_class = property(fset=_packet_context_field_class) | |
320 | ||
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" | |
326 | ) | |
37a93d41 | 327 | |
a373e036 SM |
328 | _event_common_context_field_class = property(fset=_event_common_context_field_class) |
329 | ||
330 | def _default_clock_class(self, clock_class): | |
331 | native_bt.stream_class_set_default_clock_class(self._ptr, clock_class._ptr) | |
332 | ||
333 | _default_clock_class = property(fset=_default_clock_class) | |
334 | ||
335 | @classmethod | |
336 | def _validate_create_params( | |
337 | cls, | |
338 | name, | |
339 | user_attributes, | |
340 | packet_context_field_class, | |
341 | event_common_context_field_class, | |
342 | default_clock_class, | |
343 | assigns_automatic_event_class_id, | |
344 | assigns_automatic_stream_id, | |
345 | supports_packets, | |
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, | |
352 | ): | |
353 | # Name | |
354 | if name is not None: | |
355 | utils._check_str(name) | |
356 | ||
357 | # User attributes | |
358 | if user_attributes is not None: | |
359 | value = bt2_value.create_value(user_attributes) | |
360 | utils._check_type(value, bt2_value.MapValue) | |
361 | ||
362 | # Packet context field class | |
363 | if packet_context_field_class is not None: | |
364 | if not supports_packets: | |
d5a22ce8 SM |
365 | raise ValueError( |
366 | 'cannot have a packet context field class without supporting packets' | |
367 | ) | |
37a93d41 | 368 | |
a373e036 SM |
369 | utils._check_type( |
370 | packet_context_field_class, bt2_field_class._StructureFieldClass | |
61d96b89 | 371 | ) |
81447b5b | 372 | |
a373e036 | 373 | # Event common context field class |
060aee52 | 374 | if event_common_context_field_class is not None: |
61d96b89 | 375 | utils._check_type( |
c946c9de | 376 | event_common_context_field_class, bt2_field_class._StructureFieldClass |
61d96b89 | 377 | ) |
81447b5b | 378 | |
a373e036 SM |
379 | # Default clock class |
380 | if default_clock_class is not None: | |
381 | utils._check_type(default_clock_class, bt2_clock_class._ClockClass) | |
382 | ||
383 | # Assigns automatic event class id | |
384 | utils._check_bool(assigns_automatic_event_class_id) | |
385 | ||
386 | # Assigns automatic stream id | |
387 | utils._check_bool(assigns_automatic_stream_id) | |
388 | ||
389 | # Packets | |
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) | |
393 | ||
394 | if not supports_packets: | |
395 | if packets_have_beginning_default_clock_snapshot: | |
396 | raise ValueError( | |
397 | 'cannot not support packets, but have packet beginning default clock snapshot' | |
398 | ) | |
399 | if packets_have_end_default_clock_snapshot: | |
400 | raise ValueError( | |
401 | 'cannot not support packets, but have packet end default clock snapshots' | |
402 | ) | |
403 | ||
404 | # Discarded events | |
405 | utils._check_bool(supports_discarded_events) | |
406 | utils._check_bool(discarded_events_have_default_clock_snapshots) | |
407 | ||
408 | if ( | |
409 | not supports_discarded_events | |
410 | and discarded_events_have_default_clock_snapshots | |
411 | ): | |
412 | raise ValueError( | |
413 | 'cannot not support discarded events, but have default clock snapshots for discarded event messages' | |
61d96b89 | 414 | ) |
81447b5b | 415 | |
a373e036 SM |
416 | # Discarded packets |
417 | utils._check_bool(supports_discarded_packets) | |
418 | utils._check_bool(discarded_packets_have_default_clock_snapshots) | |
81447b5b | 419 | |
a373e036 SM |
420 | if supports_discarded_packets and not supports_packets: |
421 | raise ValueError( | |
422 | 'cannot support discarded packets, but not support packets' | |
423 | ) | |
81447b5b | 424 | |
a373e036 SM |
425 | if ( |
426 | not supports_discarded_packets | |
427 | and discarded_packets_have_default_clock_snapshots | |
428 | ): | |
429 | raise ValueError( | |
430 | 'cannot not support discarded packets, but have default clock snapshots for discarded packet messages' | |
431 | ) |