bindings/python/bt2/bt2/clock_snapshot.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 import numbers
  25 import bt2
  26 import functools
  27
  28
  29 class _BaseClockSnapshot(object._UniqueObject):
  30     @property
  31     def clock_class(self):
  32         cc_ptr = native_bt.clock_snapshot_borrow_clock_class_const(self._ptr)
  33         assert cc_ptr is not None
  34         return bt2.clock_class._ClockClass._create_from_ptr_and_get_ref(cc_ptr)
  35
  36
  37 @functools.total_ordering
  38 class _ClockSnapshot(_BaseClockSnapshot):
  39     @property
  40     def value(self):
  41         return native_bt.clock_snapshot_get_value(self._ptr)
  42
  43     @property
  44     def ns_from_origin(self):
  45         ret, ns = native_bt.clock_snapshot_get_ns_from_origin(self._ptr)
  46
  47         if ret == native_bt.CLOCK_SNAPSHOT_STATUS_OVERFLOW:
  48             raise OverflowError("cannot get clock snapshot's nanoseconds from origin")
  49
  50         return ns
  51
  52     def __eq__(self, other):
  53         if not isinstance(other, numbers.Integral):
  54             return NotImplemented
  55
  56         return self.value == int(other)
  57
  58     def __lt__(self, other):
  59         if not isinstance(other, numbers.Integral):
  60             return NotImplemented
  61
  62         return self.value < int(other)
  63
  64
  65 class _UnknownClockSnapshot(_BaseClockSnapshot):
  66     pass
  67
  68
  69 class _InfiniteClockSnapshot(_BaseClockSnapshot):
  70     pass