Commit | Line | Data |
---|---|---|
81447b5b PP |
1 | # The MIT License (MIT) |
2 | # | |
811644b8 | 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 | |
b4f45851 | 24 | import bt2.field_class |
81447b5b PP |
25 | import collections.abc |
26 | import bt2.ctf_writer | |
27 | import bt2.stream | |
81447b5b PP |
28 | import bt2 |
29 | ||
30 | ||
78288f58 | 31 | class StreamClass(object._SharedObject, collections.abc.Mapping): |
fbbe9302 SM |
32 | _get_ref = staticmethod(native_bt.stream_class_get_ref) |
33 | _put_ref = staticmethod(native_bt.stream_class_put_ref) | |
34 | ||
81447b5b | 35 | def __getitem__(self, key): |
811644b8 | 36 | utils._check_int64(key) |
3cdfbaea | 37 | ec_ptr = native_bt.stream_class_borrow_event_class_by_id(self._ptr, key) |
81447b5b PP |
38 | |
39 | if ec_ptr is None: | |
40 | raise KeyError(key) | |
41 | ||
3cdfbaea | 42 | return bt2.EventClass._create_from_ptr_and_get_ref(ec_ptr) |
81447b5b PP |
43 | |
44 | def __len__(self): | |
50842bdc | 45 | count = native_bt.stream_class_get_event_class_count(self._ptr) |
3cdfbaea | 46 | assert count >= 0 |
81447b5b PP |
47 | return count |
48 | ||
49 | def __iter__(self): | |
3cdfbaea SM |
50 | for idx in range(len(self)): |
51 | ec_ptr = native_bt.stream_class_borrow_event_class_by_index_const(self._ptr, idx) | |
52 | assert ec_ptr is not None | |
53 | ||
54 | id = native_bt.event_class_get_id(ec_ptr) | |
55 | assert id >= 0 | |
56 | ||
57 | yield id | |
81447b5b | 58 | |
af4bbfc7 SM |
59 | def create_event_class(self, id=None, name=None, log_level=None, emf_uri=None, |
60 | specific_context_field_class=None, | |
61 | payload_field_class=None): | |
3cdfbaea SM |
62 | if self.assigns_automatic_event_class_id: |
63 | if id is not None: | |
64 | raise bt2.CreationError('id provided, but stream class assigns automatic event class ids') | |
65 | ||
66 | ec_ptr = native_bt.event_class_create(self._ptr) | |
67 | else: | |
68 | if id is None: | |
69 | raise bt2.CreationError('id not provided, but stream class does not assign automatic event class ids') | |
70 | ||
71 | utils._check_uint64(id) | |
72 | ec_ptr = native_bt.event_class_create_with_id(self._ptr, id) | |
73 | ||
af4bbfc7 SM |
74 | event_class = bt2.event_class.EventClass._create_from_ptr(ec_ptr) |
75 | ||
76 | if name is not None: | |
77 | event_class._name = name | |
78 | ||
79 | if log_level is not None: | |
80 | event_class._log_level = log_level | |
81 | ||
82 | if emf_uri is not None: | |
83 | event_class._emf_uri = emf_uri | |
84 | ||
85 | if specific_context_field_class is not None: | |
86 | event_class._specific_context_field_class = specific_context_field_class | |
87 | ||
88 | if payload_field_class is not None: | |
89 | event_class._payload_field_class = payload_field_class | |
90 | ||
91 | return event_class | |
81447b5b PP |
92 | |
93 | @property | |
3cdfbaea SM |
94 | def trace_class(self): |
95 | tc_ptr = native_bt.stream_class_borrow_trace_class_const(self._ptr) | |
81447b5b PP |
96 | |
97 | if tc_ptr is not None: | |
3cdfbaea | 98 | return bt2.TraceClass._create_from_ptr_and_get_ref(tc_ptr) |
81447b5b PP |
99 | |
100 | @property | |
101 | def name(self): | |
50842bdc | 102 | return native_bt.stream_class_get_name(self._ptr) |
81447b5b | 103 | |
3cdfbaea | 104 | def _name(self, name): |
81447b5b | 105 | utils._check_str(name) |
50842bdc | 106 | ret = native_bt.stream_class_set_name(self._ptr, name) |
81447b5b PP |
107 | utils._handle_ret(ret, "cannot set stream class object's name") |
108 | ||
3cdfbaea SM |
109 | _name = property(fset=_name) |
110 | ||
111 | @property | |
112 | def assigns_automatic_event_class_id(self): | |
113 | return native_bt.stream_class_assigns_automatic_event_class_id(self._ptr) | |
114 | ||
115 | def _assigns_automatic_event_class_id(self, auto_id): | |
116 | utils._check_bool(auto_id) | |
117 | return native_bt.stream_class_set_assigns_automatic_event_class_id(self._ptr, auto_id) | |
118 | ||
119 | _assigns_automatic_event_class_id = property(fset=_assigns_automatic_event_class_id) | |
120 | ||
8c2367b8 SM |
121 | @property |
122 | def assigns_automatic_stream_id(self): | |
123 | return native_bt.stream_class_assigns_automatic_stream_id(self._ptr) | |
124 | ||
125 | def _assigns_automatic_stream_id(self, auto_id): | |
126 | utils._check_bool(auto_id) | |
127 | return native_bt.stream_class_set_assigns_automatic_stream_id(self._ptr, auto_id) | |
128 | ||
129 | _assigns_automatic_stream_id = property(fset=_assigns_automatic_stream_id) | |
130 | ||
3cdfbaea SM |
131 | @property |
132 | def packets_have_default_beginning_clock_snapshot(self): | |
133 | return native_bt.stream_class_packets_have_default_beginning_clock_snapshot(self._ptr) | |
134 | ||
135 | def _packets_have_default_beginning_clock_snapshot(self, value): | |
136 | utils._check_bool(value) | |
137 | native_bt.stream_class_set_packets_have_default_beginning_clock_snapshot(self._ptr, value) | |
138 | ||
139 | _packets_have_default_beginning_clock_snapshot = property(fset=_packets_have_default_beginning_clock_snapshot) | |
140 | ||
141 | @property | |
142 | def packets_have_default_end_clock_snapshot(self): | |
143 | return native_bt.stream_class_packets_have_default_end_clock_snapshot(self._ptr) | |
144 | ||
145 | def _packets_have_default_end_clock_snapshot(self, value): | |
146 | utils._check_bool(value) | |
147 | native_bt.stream_class_set_packets_have_default_end_clock_snapshot(self._ptr, value) | |
148 | ||
149 | _packets_have_default_end_clock_snapshot = property(fset=_packets_have_default_end_clock_snapshot) | |
150 | ||
81447b5b PP |
151 | @property |
152 | def id(self): | |
50842bdc | 153 | id = native_bt.stream_class_get_id(self._ptr) |
81447b5b | 154 | |
811644b8 PP |
155 | if id < 0: |
156 | return | |
81447b5b PP |
157 | |
158 | return id | |
159 | ||
160 | @id.setter | |
161 | def id(self, id): | |
162 | utils._check_int64(id) | |
50842bdc | 163 | ret = native_bt.stream_class_set_id(self._ptr, id) |
81447b5b PP |
164 | utils._handle_ret(ret, "cannot set stream class object's ID") |
165 | ||
166 | @property | |
167 | def clock(self): | |
50842bdc | 168 | clock_ptr = native_bt.stream_class_get_clock(self._ptr) |
81447b5b PP |
169 | |
170 | if clock_ptr is None: | |
171 | return | |
172 | ||
173 | return bt2.ctf_writer.CtfWriterClock._create_from_ptr(clock_ptr) | |
174 | ||
175 | @clock.setter | |
176 | def clock(self, clock): | |
177 | utils._check_type(clock, bt2.ctf_writer.CtfWriterClock) | |
50842bdc | 178 | ret = native_bt.stream_class_set_clock(self._ptr, clock._ptr) |
81447b5b PP |
179 | utils._handle_ret(ret, "cannot set stream class object's CTF writer clock object") |
180 | ||
181 | @property | |
b4f45851 | 182 | def packet_context_field_class(self): |
3cdfbaea | 183 | fc_ptr = native_bt.stream_class_borrow_packet_context_field_class_const(self._ptr) |
81447b5b | 184 | |
b4f45851 | 185 | if fc_ptr is None: |
81447b5b PP |
186 | return |
187 | ||
3cdfbaea | 188 | return bt2.field_class._create_field_class_from_ptr_and_get_ref(fc_ptr) |
81447b5b | 189 | |
3cdfbaea | 190 | def _packet_context_field_class(self, packet_context_field_class): |
b4f45851 | 191 | if packet_context_field_class is not None: |
3cdfbaea SM |
192 | utils._check_type(packet_context_field_class, |
193 | bt2.field_class._StructureFieldClass) | |
194 | ret = native_bt.stream_class_set_packet_context_field_class(self._ptr, | |
195 | packet_context_field_class._ptr) | |
196 | utils._handle_ret(ret, "cannot set stream class' packet context field class") | |
81447b5b | 197 | |
3cdfbaea | 198 | _packet_context_field_class = property(fset=_packet_context_field_class) |
81447b5b PP |
199 | |
200 | @property | |
3cdfbaea SM |
201 | def event_common_context_field_class(self): |
202 | fc_ptr = native_bt.stream_class_borrow_event_common_context_field_class_const(self._ptr) | |
81447b5b | 203 | |
b4f45851 | 204 | if fc_ptr is None: |
81447b5b PP |
205 | return |
206 | ||
3cdfbaea | 207 | return bt2.field_class._create_field_class_from_ptr_and_get_ref(fc_ptr) |
81447b5b | 208 | |
3cdfbaea SM |
209 | def _event_common_context_field_class(self, event_common_context_field_class): |
210 | if event_common_context_field_class is not None: | |
211 | utils._check_type(event_common_context_field_class, | |
212 | bt2.field_class._StructureFieldClass) | |
81447b5b | 213 | |
3cdfbaea SM |
214 | set_context_fn = native_bt.stream_class_set_event_common_context_field_class |
215 | ret = set_context_fn(self._ptr, event_common_context_field_class._ptr) | |
81447b5b | 216 | |
3cdfbaea | 217 | utils._handle_ret(ret, "cannot set stream class' event context field type") |
81447b5b | 218 | |
3cdfbaea | 219 | _event_common_context_field_class = property(fset=_event_common_context_field_class) |
81447b5b | 220 | |
3cdfbaea SM |
221 | @property |
222 | def default_clock_class(self): | |
223 | cc_ptr = native_bt.stream_class_borrow_default_clock_class(self._ptr) | |
224 | if cc_ptr is None: | |
81447b5b PP |
225 | return |
226 | ||
be7bbff9 | 227 | return bt2.clock_class._ClockClass._create_from_ptr_and_get_ref(cc_ptr) |
81447b5b | 228 | |
3cdfbaea | 229 | def _default_clock_class(self, clock_class): |
be7bbff9 | 230 | utils._check_type(clock_class, bt2.clock_class._ClockClass) |
3cdfbaea SM |
231 | native_bt.stream_class_set_default_clock_class( |
232 | self._ptr, clock_class._ptr) | |
81447b5b | 233 | |
3cdfbaea | 234 | _default_clock_class = property(fset=_default_clock_class) |