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 | |
81447b5b | 24 | import bt2 |
be7bbff9 | 25 | import uuid as uuidp |
81447b5b | 26 | |
0b03f63e | 27 | |
81447b5b PP |
28 | class ClockClassOffset: |
29 | def __init__(self, seconds=0, cycles=0): | |
30 | utils._check_int64(seconds) | |
31 | utils._check_int64(cycles) | |
32 | self._seconds = seconds | |
33 | self._cycles = cycles | |
34 | ||
35 | @property | |
36 | def seconds(self): | |
37 | return self._seconds | |
38 | ||
39 | @property | |
40 | def cycles(self): | |
41 | return self._cycles | |
42 | ||
43 | def __eq__(self, other): | |
44 | if not isinstance(other, self.__class__): | |
45 | # not comparing apples to apples | |
46 | return False | |
47 | ||
48 | return (self.seconds, self.cycles) == (other.seconds, other.cycles) | |
49 | ||
50 | ||
be7bbff9 | 51 | class _ClockClass(object._SharedObject): |
3cdfbaea SM |
52 | _get_ref = staticmethod(native_bt.clock_class_get_ref) |
53 | _put_ref = staticmethod(native_bt.clock_class_put_ref) | |
54 | ||
81447b5b PP |
55 | @property |
56 | def name(self): | |
be7bbff9 | 57 | return native_bt.clock_class_get_name(self._ptr) |
81447b5b | 58 | |
be7bbff9 | 59 | def _name(self, name): |
81447b5b | 60 | utils._check_str(name) |
d24d5663 | 61 | status = native_bt.clock_class_set_name(self._ptr, name) |
cfbd7cf3 | 62 | utils._handle_func_status(status, "cannot set clock class object's name") |
81447b5b | 63 | |
be7bbff9 SM |
64 | _name = property(fset=_name) |
65 | ||
81447b5b PP |
66 | @property |
67 | def description(self): | |
50842bdc | 68 | return native_bt.clock_class_get_description(self._ptr) |
81447b5b | 69 | |
be7bbff9 | 70 | def _description(self, description): |
81447b5b | 71 | utils._check_str(description) |
d24d5663 | 72 | status = native_bt.clock_class_set_description(self._ptr, description) |
cfbd7cf3 | 73 | utils._handle_func_status(status, "cannot set clock class object's description") |
81447b5b | 74 | |
be7bbff9 SM |
75 | _description = property(fset=_description) |
76 | ||
81447b5b PP |
77 | @property |
78 | def frequency(self): | |
be7bbff9 | 79 | return native_bt.clock_class_get_frequency(self._ptr) |
81447b5b | 80 | |
be7bbff9 | 81 | def _frequency(self, frequency): |
81447b5b | 82 | utils._check_uint64(frequency) |
be7bbff9 SM |
83 | native_bt.clock_class_set_frequency(self._ptr, frequency) |
84 | ||
85 | _frequency = property(fset=_frequency) | |
81447b5b PP |
86 | |
87 | @property | |
88 | def precision(self): | |
50842bdc | 89 | precision = native_bt.clock_class_get_precision(self._ptr) |
81447b5b PP |
90 | return precision |
91 | ||
be7bbff9 | 92 | def _precision(self, precision): |
81447b5b | 93 | utils._check_uint64(precision) |
be7bbff9 SM |
94 | native_bt.clock_class_set_precision(self._ptr, precision) |
95 | ||
96 | _precision = property(fset=_precision) | |
81447b5b PP |
97 | |
98 | @property | |
99 | def offset(self): | |
be7bbff9 | 100 | offset_s, offset_cycles = native_bt.clock_class_get_offset(self._ptr) |
81447b5b PP |
101 | return ClockClassOffset(offset_s, offset_cycles) |
102 | ||
be7bbff9 | 103 | def _offset(self, offset): |
81447b5b | 104 | utils._check_type(offset, ClockClassOffset) |
be7bbff9 SM |
105 | native_bt.clock_class_set_offset(self._ptr, offset.seconds, offset.cycles) |
106 | ||
107 | _offset = property(fset=_offset) | |
81447b5b PP |
108 | |
109 | @property | |
be7bbff9 SM |
110 | def origin_is_unix_epoch(self): |
111 | return native_bt.clock_class_origin_is_unix_epoch(self._ptr) | |
81447b5b | 112 | |
be7bbff9 SM |
113 | def _origin_is_unix_epoch(self, origin_is_unix_epoch): |
114 | utils._check_bool(origin_is_unix_epoch) | |
cfbd7cf3 FD |
115 | native_bt.clock_class_set_origin_is_unix_epoch( |
116 | self._ptr, int(origin_is_unix_epoch) | |
117 | ) | |
be7bbff9 SM |
118 | |
119 | _origin_is_unix_epoch = property(fset=_origin_is_unix_epoch) | |
81447b5b PP |
120 | |
121 | @property | |
122 | def uuid(self): | |
50842bdc | 123 | uuid_bytes = native_bt.clock_class_get_uuid(self._ptr) |
81447b5b PP |
124 | |
125 | if uuid_bytes is None: | |
811644b8 | 126 | return |
81447b5b PP |
127 | |
128 | return uuidp.UUID(bytes=uuid_bytes) | |
129 | ||
be7bbff9 | 130 | def _uuid(self, uuid): |
81447b5b | 131 | utils._check_type(uuid, uuidp.UUID) |
be7bbff9 SM |
132 | native_bt.clock_class_set_uuid(self._ptr, uuid.bytes) |
133 | ||
134 | _uuid = property(fset=_uuid) | |
135 | ||
136 | def cycles_to_ns_from_origin(self, cycles): | |
137 | utils._check_uint64(cycles) | |
d24d5663 | 138 | status, ns = native_bt.clock_class_cycles_to_ns_from_origin(self._ptr, cycles) |
be7bbff9 | 139 | error_msg = "cannot convert clock value to nanoseconds from origin for given clock class" |
d24d5663 | 140 | utils._handle_func_status(status, error_msg) |
be7bbff9 | 141 | return ns |