lib: graph: add "self" and some "private" APIs
[babeltrace.git] / include / babeltrace / ctf-writer / clock-class-internal.h
CommitLineData
16ca5ff0
PP
1#ifndef BABELTRACE_CTF_WRITER_CLOCK_CLASS_INTERNAL_H
2#define BABELTRACE_CTF_WRITER_CLOCK_CLASS_INTERNAL_H
3
4/*
16ca5ff0
PP
5 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 *
7 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 * SOFTWARE.
26 */
27
28#include <babeltrace/object-internal.h>
29#include <babeltrace/babeltrace-internal.h>
30#include <babeltrace/object-pool-internal.h>
31#include <babeltrace/compat/uuid-internal.h>
32#include <babeltrace/types.h>
33#include <stdbool.h>
34#include <stdint.h>
35#include <glib.h>
36
37struct bt_ctf_clock_class {
38 struct bt_object base;
39 GString *name;
40 GString *description;
41 uint64_t frequency;
42 uint64_t precision;
43 int64_t offset_s; /* Offset in seconds */
44 int64_t offset; /* Offset in ticks */
45 unsigned char uuid[BABELTRACE_UUID_LEN];
46 int uuid_set;
47 int absolute;
48
49 /*
50 * A clock's properties can't be modified once it is added to a stream
51 * class.
52 */
53 int frozen;
54};
55
56BT_HIDDEN
57void bt_ctf_clock_class_freeze(struct bt_ctf_clock_class *clock_class);
58
59BT_HIDDEN
60bt_bool bt_ctf_clock_class_is_valid(struct bt_ctf_clock_class *clock_class);
61
62BT_HIDDEN
63int bt_ctf_clock_class_compare(struct bt_ctf_clock_class *clock_class_a,
64 struct bt_ctf_clock_class *clock_class_b);
65
66BT_HIDDEN
67struct bt_ctf_clock_class *bt_ctf_clock_class_create(const char *name,
68 uint64_t freq);
69BT_HIDDEN
70const char *bt_ctf_clock_class_get_name(
71 struct bt_ctf_clock_class *clock_class);
72BT_HIDDEN
73int bt_ctf_clock_class_set_name(struct bt_ctf_clock_class *clock_class,
74 const char *name);
75BT_HIDDEN
76const char *bt_ctf_clock_class_get_description(
77 struct bt_ctf_clock_class *clock_class);
78BT_HIDDEN
79int bt_ctf_clock_class_set_description(
80 struct bt_ctf_clock_class *clock_class,
81 const char *desc);
82BT_HIDDEN
83uint64_t bt_ctf_clock_class_get_frequency(
84 struct bt_ctf_clock_class *clock_class);
85BT_HIDDEN
86int bt_ctf_clock_class_set_frequency(
87 struct bt_ctf_clock_class *clock_class, uint64_t freq);
88BT_HIDDEN
89uint64_t bt_ctf_clock_class_get_precision(
90 struct bt_ctf_clock_class *clock_class);
91BT_HIDDEN
92int bt_ctf_clock_class_set_precision(
93 struct bt_ctf_clock_class *clock_class, uint64_t precision);
94BT_HIDDEN
95int bt_ctf_clock_class_get_offset_s(
96 struct bt_ctf_clock_class *clock_class, int64_t *seconds);
97BT_HIDDEN
98int bt_ctf_clock_class_set_offset_s(
99 struct bt_ctf_clock_class *clock_class, int64_t seconds);
100BT_HIDDEN
101int bt_ctf_clock_class_get_offset_cycles(
102 struct bt_ctf_clock_class *clock_class, int64_t *cycles);
103BT_HIDDEN
104int bt_ctf_clock_class_set_offset_cycles(
105 struct bt_ctf_clock_class *clock_class, int64_t cycles);
106BT_HIDDEN
107bt_bool bt_ctf_clock_class_is_absolute(
108 struct bt_ctf_clock_class *clock_class);
109BT_HIDDEN
110int bt_ctf_clock_class_set_is_absolute(
111 struct bt_ctf_clock_class *clock_class, bt_bool is_absolute);
112BT_HIDDEN
113const unsigned char *bt_ctf_clock_class_get_uuid(
114 struct bt_ctf_clock_class *clock_class);
115BT_HIDDEN
116int bt_ctf_clock_class_set_uuid(struct bt_ctf_clock_class *clock_class,
117 const unsigned char *uuid);
118
119#endif /* BABELTRACE_CTF_WRITER_CLOCK_CLASS_INTERNAL_H */
This page took 0.028305 seconds and 4 git commands to generate.