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 value
as bt2_value
28 class ClockClassOffset
:
29 def __init__(self
, seconds
=0, cycles
=0):
30 utils
._check
_int
64(seconds
)
31 utils
._check
_int
64(cycles
)
32 self
._seconds
= seconds
43 def __eq__(self
, other
):
44 if not isinstance(other
, self
.__class
__):
45 # not comparing apples to apples
48 return (self
.seconds
, self
.cycles
) == (other
.seconds
, other
.cycles
)
51 class _ClockClassConst(object._SharedObject
):
52 _get_ref
= staticmethod(native_bt
.clock_class_get_ref
)
53 _put_ref
= staticmethod(native_bt
.clock_class_put_ref
)
54 _create_value_from_ptr_and_get_ref
= staticmethod(
55 bt2_value
._create
_from
_const
_ptr
_and
_get
_ref
57 _borrow_user_attributes_ptr
= staticmethod(
58 native_bt
.clock_class_borrow_user_attributes_const
62 def user_attributes(self
):
63 ptr
= self
._borrow
_user
_attributes
_ptr
(self
._ptr
)
64 assert ptr
is not None
65 return self
._create
_value
_from
_ptr
_and
_get
_ref
(ptr
)
69 return native_bt
.clock_class_get_name(self
._ptr
)
72 def description(self
):
73 return native_bt
.clock_class_get_description(self
._ptr
)
77 return native_bt
.clock_class_get_frequency(self
._ptr
)
81 precision
= native_bt
.clock_class_get_precision(self
._ptr
)
86 offset_s
, offset_cycles
= native_bt
.clock_class_get_offset(self
._ptr
)
87 return ClockClassOffset(offset_s
, offset_cycles
)
90 def origin_is_unix_epoch(self
):
91 return native_bt
.clock_class_origin_is_unix_epoch(self
._ptr
)
95 uuid_bytes
= native_bt
.clock_class_get_uuid(self
._ptr
)
97 if uuid_bytes
is None:
100 return uuidp
.UUID(bytes
=uuid_bytes
)
102 def cycles_to_ns_from_origin(self
, cycles
):
103 utils
._check
_uint
64(cycles
)
104 status
, ns
= native_bt
.clock_class_cycles_to_ns_from_origin(self
._ptr
, cycles
)
105 error_msg
= "cannot convert clock value to nanoseconds from origin for given clock class"
106 utils
._handle
_func
_status
(status
, error_msg
)
110 class _ClockClass(_ClockClassConst
):
111 _create_value_from_ptr_and_get_ref
= staticmethod(
112 bt2_value
._create
_from
_ptr
_and
_get
_ref
114 _borrow_user_attributes_ptr
= staticmethod(
115 native_bt
.clock_class_borrow_user_attributes
118 def _user_attributes(self
, user_attributes
):
119 value
= bt2_value
.create_value(user_attributes
)
120 utils
._check
_type
(value
, bt2_value
.MapValue
)
121 native_bt
.clock_class_set_user_attributes(self
._ptr
, value
._ptr
)
123 _user_attributes
= property(fset
=_user_attributes
)
125 def _name(self
, name
):
126 utils
._check
_str
(name
)
127 status
= native_bt
.clock_class_set_name(self
._ptr
, name
)
128 utils
._handle
_func
_status
(status
, "cannot set clock class object's name")
130 _name
= property(fset
=_name
)
132 def _description(self
, description
):
133 utils
._check
_str
(description
)
134 status
= native_bt
.clock_class_set_description(self
._ptr
, description
)
135 utils
._handle
_func
_status
(status
, "cannot set clock class object's description")
137 _description
= property(fset
=_description
)
139 def _frequency(self
, frequency
):
140 utils
._check
_uint
64(frequency
)
141 native_bt
.clock_class_set_frequency(self
._ptr
, frequency
)
143 _frequency
= property(fset
=_frequency
)
145 def _precision(self
, precision
):
146 utils
._check
_uint
64(precision
)
147 native_bt
.clock_class_set_precision(self
._ptr
, precision
)
149 _precision
= property(fset
=_precision
)
151 def _offset(self
, offset
):
152 utils
._check
_type
(offset
, ClockClassOffset
)
153 native_bt
.clock_class_set_offset(self
._ptr
, offset
.seconds
, offset
.cycles
)
155 _offset
= property(fset
=_offset
)
157 def _origin_is_unix_epoch(self
, origin_is_unix_epoch
):
158 utils
._check
_bool
(origin_is_unix_epoch
)
159 native_bt
.clock_class_set_origin_is_unix_epoch(
160 self
._ptr
, int(origin_is_unix_epoch
)
163 _origin_is_unix_epoch
= property(fset
=_origin_is_unix_epoch
)
165 def _uuid(self
, uuid
):
166 utils
._check
_type
(uuid
, uuidp
.UUID
)
167 native_bt
.clock_class_set_uuid(self
._ptr
, uuid
.bytes
)
169 _uuid
= property(fset
=_uuid
)