src/bindings/python/bt2/bt2/clock_class.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
   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
  24 from bt2 import value as bt2_value
  25 import uuid as uuidp
  26
  27
  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
  51 class _ClockClass(object._SharedObject):
  52     _get_ref = staticmethod(native_bt.clock_class_get_ref)
  53     _put_ref = staticmethod(native_bt.clock_class_put_ref)
  54
  55     @property
  56     def user_attributes(self):
  57         ptr = native_bt.clock_class_borrow_user_attributes(self._ptr)
  58         assert ptr is not None
  59         return bt2_value._create_from_ptr_and_get_ref(ptr)
  60
  61     def _user_attributes(self, user_attributes):
  62         value = bt2_value.create_value(user_attributes)
  63         utils._check_type(value, bt2_value.MapValue)
  64         native_bt.clock_class_set_user_attributes(self._ptr, value._ptr)
  65
  66     _user_attributes = property(fset=_user_attributes)
  67
  68     @property
  69     def name(self):
  70         return native_bt.clock_class_get_name(self._ptr)
  71
  72     def _name(self, name):
  73         utils._check_str(name)
  74         status = native_bt.clock_class_set_name(self._ptr, name)
  75         utils._handle_func_status(status, "cannot set clock class object's name")
  76
  77     _name = property(fset=_name)
  78
  79     @property
  80     def description(self):
  81         return native_bt.clock_class_get_description(self._ptr)
  82
  83     def _description(self, description):
  84         utils._check_str(description)
  85         status = native_bt.clock_class_set_description(self._ptr, description)
  86         utils._handle_func_status(status, "cannot set clock class object's description")
  87
  88     _description = property(fset=_description)
  89
  90     @property
  91     def frequency(self):
  92         return native_bt.clock_class_get_frequency(self._ptr)
  93
  94     def _frequency(self, frequency):
  95         utils._check_uint64(frequency)
  96         native_bt.clock_class_set_frequency(self._ptr, frequency)
  97
  98     _frequency = property(fset=_frequency)
  99
 100     @property
 101     def precision(self):
 102         precision = native_bt.clock_class_get_precision(self._ptr)
 103         return precision
 104
 105     def _precision(self, precision):
 106         utils._check_uint64(precision)
 107         native_bt.clock_class_set_precision(self._ptr, precision)
 108
 109     _precision = property(fset=_precision)
 110
 111     @property
 112     def offset(self):
 113         offset_s, offset_cycles = native_bt.clock_class_get_offset(self._ptr)
 114         return ClockClassOffset(offset_s, offset_cycles)
 115
 116     def _offset(self, offset):
 117         utils._check_type(offset, ClockClassOffset)
 118         native_bt.clock_class_set_offset(self._ptr, offset.seconds, offset.cycles)
 119
 120     _offset = property(fset=_offset)
 121
 122     @property
 123     def origin_is_unix_epoch(self):
 124         return native_bt.clock_class_origin_is_unix_epoch(self._ptr)
 125
 126     def _origin_is_unix_epoch(self, origin_is_unix_epoch):
 127         utils._check_bool(origin_is_unix_epoch)
 128         native_bt.clock_class_set_origin_is_unix_epoch(
 129             self._ptr, int(origin_is_unix_epoch)
 130         )
 131
 132     _origin_is_unix_epoch = property(fset=_origin_is_unix_epoch)
 133
 134     @property
 135     def uuid(self):
 136         uuid_bytes = native_bt.clock_class_get_uuid(self._ptr)
 137
 138         if uuid_bytes is None:
 139             return
 140
 141         return uuidp.UUID(bytes=uuid_bytes)
 142
 143     def _uuid(self, uuid):
 144         utils._check_type(uuid, uuidp.UUID)
 145         native_bt.clock_class_set_uuid(self._ptr, uuid.bytes)
 146
 147     _uuid = property(fset=_uuid)
 148
 149     def cycles_to_ns_from_origin(self, cycles):
 150         utils._check_uint64(cycles)
 151         status, ns = native_bt.clock_class_cycles_to_ns_from_origin(self._ptr, cycles)
 152         error_msg = "cannot convert clock value to nanoseconds from origin for given clock class"
 153         utils._handle_func_status(status, error_msg)
 154         return ns