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 import bt2
.field_class
25 import collections
.abc
31 class StreamClass(object._SharedObject
, collections
.abc
.Mapping
):
32 _get_ref
= staticmethod(native_bt
.stream_class_get_ref
)
33 _put_ref
= staticmethod(native_bt
.stream_class_put_ref
)
35 def __getitem__(self
, key
):
36 utils
._check
_int
64(key
)
37 ec_ptr
= native_bt
.stream_class_borrow_event_class_by_id(self
._ptr
, key
)
42 return bt2
.EventClass
._create
_from
_ptr
_and
_get
_ref
(ec_ptr
)
45 count
= native_bt
.stream_class_get_event_class_count(self
._ptr
)
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
54 id = native_bt
.event_class_get_id(ec_ptr
)
59 def create_event_class(self
, id=None):
60 if self
.assigns_automatic_event_class_id
:
62 raise bt2
.CreationError('id provided, but stream class assigns automatic event class ids')
64 ec_ptr
= native_bt
.event_class_create(self
._ptr
)
67 raise bt2
.CreationError('id not provided, but stream class does not assign automatic event class ids')
69 utils
._check
_uint
64(id)
70 ec_ptr
= native_bt
.event_class_create_with_id(self
._ptr
, id)
72 return bt2
.event_class
.EventClass
._create
_from
_ptr
(ec_ptr
)
75 def trace_class(self
):
76 tc_ptr
= native_bt
.stream_class_borrow_trace_class_const(self
._ptr
)
78 if tc_ptr
is not None:
79 return bt2
.TraceClass
._create
_from
_ptr
_and
_get
_ref
(tc_ptr
)
83 return native_bt
.stream_class_get_name(self
._ptr
)
85 def _name(self
, name
):
86 utils
._check
_str
(name
)
87 ret
= native_bt
.stream_class_set_name(self
._ptr
, name
)
88 utils
._handle
_ret
(ret
, "cannot set stream class object's name")
90 _name
= property(fset
=_name
)
93 def assigns_automatic_event_class_id(self
):
94 return native_bt
.stream_class_assigns_automatic_event_class_id(self
._ptr
)
96 def _assigns_automatic_event_class_id(self
, auto_id
):
97 utils
._check
_bool
(auto_id
)
98 return native_bt
.stream_class_set_assigns_automatic_event_class_id(self
._ptr
, auto_id
)
100 _assigns_automatic_event_class_id
= property(fset
=_assigns_automatic_event_class_id
)
103 def assigns_automatic_stream_id(self
):
104 return native_bt
.stream_class_assigns_automatic_stream_id(self
._ptr
)
106 def _assigns_automatic_stream_id(self
, auto_id
):
107 utils
._check
_bool
(auto_id
)
108 return native_bt
.stream_class_set_assigns_automatic_stream_id(self
._ptr
, auto_id
)
110 _assigns_automatic_stream_id
= property(fset
=_assigns_automatic_stream_id
)
113 def packets_have_default_beginning_clock_snapshot(self
):
114 return native_bt
.stream_class_packets_have_default_beginning_clock_snapshot(self
._ptr
)
116 def _packets_have_default_beginning_clock_snapshot(self
, value
):
117 utils
._check
_bool
(value
)
118 native_bt
.stream_class_set_packets_have_default_beginning_clock_snapshot(self
._ptr
, value
)
120 _packets_have_default_beginning_clock_snapshot
= property(fset
=_packets_have_default_beginning_clock_snapshot
)
123 def packets_have_default_end_clock_snapshot(self
):
124 return native_bt
.stream_class_packets_have_default_end_clock_snapshot(self
._ptr
)
126 def _packets_have_default_end_clock_snapshot(self
, value
):
127 utils
._check
_bool
(value
)
128 native_bt
.stream_class_set_packets_have_default_end_clock_snapshot(self
._ptr
, value
)
130 _packets_have_default_end_clock_snapshot
= property(fset
=_packets_have_default_end_clock_snapshot
)
134 id = native_bt
.stream_class_get_id(self
._ptr
)
143 utils
._check
_int
64(id)
144 ret
= native_bt
.stream_class_set_id(self
._ptr
, id)
145 utils
._handle
_ret
(ret
, "cannot set stream class object's ID")
149 clock_ptr
= native_bt
.stream_class_get_clock(self
._ptr
)
151 if clock_ptr
is None:
154 return bt2
.ctf_writer
.CtfWriterClock
._create
_from
_ptr
(clock_ptr
)
157 def clock(self
, clock
):
158 utils
._check
_type
(clock
, bt2
.ctf_writer
.CtfWriterClock
)
159 ret
= native_bt
.stream_class_set_clock(self
._ptr
, clock
._ptr
)
160 utils
._handle
_ret
(ret
, "cannot set stream class object's CTF writer clock object")
163 def packet_context_field_class(self
):
164 fc_ptr
= native_bt
.stream_class_borrow_packet_context_field_class_const(self
._ptr
)
169 return bt2
.field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(fc_ptr
)
171 def _packet_context_field_class(self
, packet_context_field_class
):
172 if packet_context_field_class
is not None:
173 utils
._check
_type
(packet_context_field_class
,
174 bt2
.field_class
._StructureFieldClass
)
175 ret
= native_bt
.stream_class_set_packet_context_field_class(self
._ptr
,
176 packet_context_field_class
._ptr
)
177 utils
._handle
_ret
(ret
, "cannot set stream class' packet context field class")
179 _packet_context_field_class
= property(fset
=_packet_context_field_class
)
182 def event_common_context_field_class(self
):
183 fc_ptr
= native_bt
.stream_class_borrow_event_common_context_field_class_const(self
._ptr
)
188 return bt2
.field_class
._create
_field
_class
_from
_ptr
_and
_get
_ref
(fc_ptr
)
190 def _event_common_context_field_class(self
, event_common_context_field_class
):
191 if event_common_context_field_class
is not None:
192 utils
._check
_type
(event_common_context_field_class
,
193 bt2
.field_class
._StructureFieldClass
)
195 set_context_fn
= native_bt
.stream_class_set_event_common_context_field_class
196 ret
= set_context_fn(self
._ptr
, event_common_context_field_class
._ptr
)
198 utils
._handle
_ret
(ret
, "cannot set stream class' event context field type")
200 _event_common_context_field_class
= property(fset
=_event_common_context_field_class
)
203 def default_clock_class(self
):
204 cc_ptr
= native_bt
.stream_class_borrow_default_clock_class(self
._ptr
)
208 return bt2
.clock_class
.ClockClass
._create
_from
_ptr
_and
_get
_ref
(cc_ptr
)
210 def _default_clock_class(self
, clock_class
):
211 utils
._check
_type
(clock_class
, bt2
.clock_class
.ClockClass
)
212 native_bt
.stream_class_set_default_clock_class(
213 self
._ptr
, clock_class
._ptr
)
215 _default_clock_class
= property(fset
=_default_clock_class
)