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 _StreamClass(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
)
36 def __getitem__(self
, key
):
37 utils
._check
_int
64(key
)
38 ec_ptr
= native_bt
.stream_class_borrow_event_class_by_id(self
._ptr
, key
)
43 return bt2_event_class
._EventClass
._create
_from
_ptr
_and
_get
_ref
(ec_ptr
)
46 count
= native_bt
.stream_class_get_event_class_count(self
._ptr
)
51 for idx
in range(len(self
)):
52 ec_ptr
= native_bt
.stream_class_borrow_event_class_by_index_const(
55 assert ec_ptr
is not None
57 id = native_bt
.event_class_get_id(ec_ptr
)
62 def create_event_class(
69 specific_context_field_class
=None,
70 payload_field_class
=None,
72 if self
.assigns_automatic_event_class_id
:
75 'id provided, but stream class assigns automatic event class ids'
78 ec_ptr
= native_bt
.event_class_create(self
._ptr
)
82 'id not provided, but stream class does not assign automatic event class ids'
85 utils
._check
_uint
64(id)
86 ec_ptr
= native_bt
.event_class_create_with_id(self
._ptr
, id)
88 event_class
= bt2_event_class
._EventClass
._create
_from
_ptr
(ec_ptr
)
91 event_class
._name
= name
93 if user_attributes
is not None:
94 event_class
._user
_attributes
= user_attributes
96 if log_level
is not None:
97 event_class
._log
_level
= log_level
99 if emf_uri
is not None:
100 event_class
._emf
_uri
= emf_uri
102 if specific_context_field_class
is not None:
103 event_class
._specific
_context
_field
_class
= specific_context_field_class
105 if payload_field_class
is not None:
106 event_class
._payload
_field
_class
= payload_field_class
111 def trace_class(self
):
112 tc_ptr
= native_bt
.stream_class_borrow_trace_class_const(self
._ptr
)
114 if tc_ptr
is not None:
115 return bt2_trace_class
._TraceClass
._create
_from
_ptr
_and
_get
_ref
(tc_ptr
)
118 def user_attributes(self
):
119 ptr
= native_bt
.stream_class_borrow_user_attributes(self
._ptr
)
120 assert ptr
is not None
121 return bt2_value
._create
_from
_ptr
_and
_get
_ref
(ptr
)
123 def _user_attributes(self
, user_attributes
):
124 value
= bt2_value
.create_value(user_attributes
)
125 utils
._check
_type
(value
, bt2_value
.MapValue
)
126 native_bt
.stream_class_set_user_attributes(self
._ptr
, value
._ptr
)
128 _user_attributes
= property(fset
=_user_attributes
)
132 return native_bt
.stream_class_get_name(self
._ptr
)
134 def _name(self
, name
):
135 utils
._check
_str
(name
)
136 status
= native_bt
.stream_class_set_name(self
._ptr
, name
)
137 utils
._handle
_func
_status
(status
, "cannot set stream class object's name")
139 _name
= property(fset
=_name
)
142 def assigns_automatic_event_class_id(self
):
143 return native_bt
.stream_class_assigns_automatic_event_class_id(self
._ptr
)
145 def _assigns_automatic_event_class_id(self
, auto_id
):
146 utils
._check
_bool
(auto_id
)
147 return native_bt
.stream_class_set_assigns_automatic_event_class_id(
151 _assigns_automatic_event_class_id
= property(fset
=_assigns_automatic_event_class_id
)
154 def assigns_automatic_stream_id(self
):
155 return native_bt
.stream_class_assigns_automatic_stream_id(self
._ptr
)
157 def _assigns_automatic_stream_id(self
, auto_id
):
158 utils
._check
_bool
(auto_id
)
159 return native_bt
.stream_class_set_assigns_automatic_stream_id(
163 _assigns_automatic_stream_id
= property(fset
=_assigns_automatic_stream_id
)
166 def supports_packets(self
):
167 return native_bt
.stream_class_supports_packets(self
._ptr
)
170 def packets_have_beginning_default_clock_snapshot(self
):
171 return native_bt
.stream_class_packets_have_beginning_default_clock_snapshot(
176 def packets_have_end_default_clock_snapshot(self
):
177 return native_bt
.stream_class_packets_have_end_default_clock_snapshot(self
._ptr
)
179 def _set_supports_packets(self
, supports
, with_begin_cs
=False, with_end_cs
=False):
180 utils
._check
_bool
(supports
)
181 utils
._check
_bool
(with_begin_cs
)
182 utils
._check
_bool
(with_end_cs
)
184 if not supports
and (with_begin_cs
or with_end_cs
):
186 'cannot not support packets, but have default clock snapshots'
189 if not supports
and self
.packet_context_field_class
is not None:
190 raise ValueError('stream class already has a packet context field class')
192 native_bt
.stream_class_set_supports_packets(
193 self
._ptr
, supports
, with_begin_cs
, with_end_cs
197 def supports_discarded_events(self
):
198 return native_bt
.stream_class_supports_discarded_events(self
._ptr
)
200 def _set_supports_discarded_events(self
, supports
, with_cs
=False):
201 utils
._check
_bool
(supports
)
202 utils
._check
_bool
(with_cs
)
204 if not supports
and with_cs
:
206 'cannot not support discarded events, but have default clock snapshots'
209 native_bt
.stream_class_set_supports_discarded_events(
210 self
._ptr
, supports
, with_cs
214 def discarded_events_have_default_clock_snapshots(self
):
215 return native_bt
.stream_class_discarded_events_have_default_clock_snapshots(
220 def supports_discarded_packets(self
):
221 return native_bt
.stream_class_supports_discarded_packets(self
._ptr
)
223 def _set_supports_discarded_packets(self
, supports
, with_cs
):
224 utils
._check
_bool
(supports
)
225 utils
._check
_bool
(with_cs
)
227 if supports
and not self
.supports_packets
:
229 'cannot support discarded packets, but not support packets'
232 if not supports
and with_cs
:
234 'cannot not support discarded packets, but have default clock snapshots'
237 native_bt
.stream_class_set_supports_discarded_packets(
238 self
._ptr
, supports
, with_cs
242 def discarded_packets_have_default_clock_snapshots(self
):
243 return native_bt
.stream_class_discarded_packets_have_default_clock_snapshots(
249 id = native_bt
.stream_class_get_id(self
._ptr
)
257 def packet_context_field_class(self
):
258 fc_ptr
= native_bt
.stream_class_borrow_packet_context_field_class_const(
265 return bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(fc_ptr
)
267 def _packet_context_field_class(self
, packet_context_field_class
):
268 if packet_context_field_class
is not None:
270 packet_context_field_class
, bt2_field_class
._StructureFieldClass
273 if not self
.supports_packets
:
274 raise ValueError('stream class does not support packets')
276 status
= native_bt
.stream_class_set_packet_context_field_class(
277 self
._ptr
, packet_context_field_class
._ptr
279 utils
._handle
_func
_status
(
280 status
, "cannot set stream class' packet context field class"
283 _packet_context_field_class
= property(fset
=_packet_context_field_class
)
286 def event_common_context_field_class(self
):
287 fc_ptr
= native_bt
.stream_class_borrow_event_common_context_field_class_const(
294 return bt2_field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(fc_ptr
)
296 def _event_common_context_field_class(self
, event_common_context_field_class
):
297 if event_common_context_field_class
is not None:
299 event_common_context_field_class
, bt2_field_class
._StructureFieldClass
302 set_context_fn
= native_bt
.stream_class_set_event_common_context_field_class
303 status
= set_context_fn(self
._ptr
, event_common_context_field_class
._ptr
)
304 utils
._handle
_func
_status
(
305 status
, "cannot set stream class' event context field type"
308 _event_common_context_field_class
= property(fset
=_event_common_context_field_class
)
311 def default_clock_class(self
):
312 cc_ptr
= native_bt
.stream_class_borrow_default_clock_class(self
._ptr
)
316 return bt2_clock_class
._ClockClass
._create
_from
_ptr
_and
_get
_ref
(cc_ptr
)
318 def _default_clock_class(self
, clock_class
):
319 utils
._check
_type
(clock_class
, bt2_clock_class
._ClockClass
)
320 native_bt
.stream_class_set_default_clock_class(self
._ptr
, clock_class
._ptr
)
322 _default_clock_class
= property(fset
=_default_clock_class
)