bindings/python/bt2/bt2/native_btclockclass.i

   1 /*
   2  * The MIT License (MIT)
   3  *
   4  * Copyright (c) 2016 Philippe Proulx <pproulx@efficios.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 /* Types */
  26 struct bt_ctf_clock_class;
  27 struct bt_ctf_clock_value;
  28
  29 /* Clock class functions */
  30 struct bt_ctf_clock_class *bt_ctf_clock_class_create(const char *name,
  31                 uint64_t freq);
  32 const char *bt_ctf_clock_class_get_name(struct bt_ctf_clock_class *clock_class);
  33 int bt_ctf_clock_class_set_name(struct bt_ctf_clock_class *clock_class, const char *name);
  34 const char *bt_ctf_clock_class_get_description(struct bt_ctf_clock_class *clock_class);
  35 int bt_ctf_clock_class_set_description(struct bt_ctf_clock_class *clock_class,
  36                 const char *desc);
  37 uint64_t bt_ctf_clock_class_get_frequency(struct bt_ctf_clock_class *clock_class);
  38 int bt_ctf_clock_class_set_frequency(struct bt_ctf_clock_class *clock_class,
  39                 uint64_t freq);
  40 uint64_t bt_ctf_clock_class_get_precision(struct bt_ctf_clock_class *clock_class);
  41 int bt_ctf_clock_class_set_precision(struct bt_ctf_clock_class *clock_class,
  42                 uint64_t precision);
  43 int bt_ctf_clock_class_get_offset_s(struct bt_ctf_clock_class *clock_class,
  44                 int64_t *OUTPUT);
  45 int bt_ctf_clock_class_set_offset_s(struct bt_ctf_clock_class *clock_class,
  46                 int64_t offset_s);
  47 int bt_ctf_clock_class_get_offset_cycles(struct bt_ctf_clock_class *clock_class,
  48                 int64_t *OUTPUT);
  49 int bt_ctf_clock_class_set_offset_cycles(struct bt_ctf_clock_class *clock_class,
  50                 int64_t offset);
  51 int bt_ctf_clock_class_is_absolute(struct bt_ctf_clock_class *clock_class);
  52 int bt_ctf_clock_class_set_is_absolute(struct bt_ctf_clock_class *clock_class,
  53                 int is_absolute);
  54 BTUUID bt_ctf_clock_class_get_uuid(struct bt_ctf_clock_class *clock_class);
  55 int bt_ctf_clock_class_set_uuid(struct bt_ctf_clock_class *clock_class,
  56                 BTUUID uuid);
  57
  58 /* Clock value functions */
  59 struct bt_ctf_clock_value *bt_ctf_clock_value_create(
  60                 struct bt_ctf_clock_class *clock_class, uint64_t value);
  61 int bt_ctf_clock_value_get_value(
  62                 struct bt_ctf_clock_value *clock_value, uint64_t *OUTPUT);
  63 int bt_ctf_clock_value_get_value_ns_from_epoch(
  64                 struct bt_ctf_clock_value *clock_value, int64_t *OUTPUT);
  65 struct bt_ctf_clock_class *bt_ctf_clock_value_get_class(
  66                 struct bt_ctf_clock_value *clock_value);