Commit | Line | Data |
---|---|---|
7b53201c PP |
1 | #ifndef BABELTRACE_GRAPH_COMPONENT_CONST_H |
2 | #define BABELTRACE_GRAPH_COMPONENT_CONST_H | |
43de0e13 JG |
3 | |
4 | /* | |
f2b0325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
43de0e13 JG |
6 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
7 | * | |
43de0e13 JG |
8 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
9 | * of this software and associated documentation files (the "Software"), to deal | |
10 | * in the Software without restriction, including without limitation the rights | |
11 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
12 | * copies of the Software, and to permit persons to whom the Software is | |
13 | * furnished to do so, subject to the following conditions: | |
14 | * | |
15 | * The above copyright notice and this permission notice shall be included in | |
16 | * all copies or substantial portions of the Software. | |
17 | * | |
18 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
19 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
20 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
21 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
22 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
23 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
24 | * SOFTWARE. | |
25 | */ | |
26 | ||
7b53201c PP |
27 | /* For enum bt_component_class_type */ |
28 | #include <babeltrace/graph/component-class-const.h> | |
e0831b38 PP |
29 | |
30 | /* For bt_bool */ | |
c55a9f58 | 31 | #include <babeltrace/types.h> |
30d619df | 32 | |
43de0e13 JG |
33 | #ifdef __cplusplus |
34 | extern "C" { | |
35 | #endif | |
36 | ||
f60c8b34 JG |
37 | struct bt_component_class; |
38 | struct bt_component_graph; | |
39 | struct bt_component; | |
40 | struct bt_value; | |
72b913fb | 41 | struct bt_port; |
f60c8b34 | 42 | |
d97bac96 | 43 | /** |
33b34c43 | 44 | * Get component's name. |
d97bac96 | 45 | * |
33b34c43 PP |
46 | * @param component Component instance of which to get the name |
47 | * @returns Returns a pointer to the component's name | |
d97bac96 | 48 | */ |
7b53201c | 49 | extern const char *bt_component_get_name(const struct bt_component *component); |
8738a040 | 50 | |
d97bac96 | 51 | /** |
33b34c43 | 52 | * Get component's class. |
d97bac96 | 53 | * |
33b34c43 PP |
54 | * @param component Component instance of which to get the class |
55 | * @returns The component's class | |
d97bac96 | 56 | */ |
7b53201c PP |
57 | extern const struct bt_component_class *bt_component_borrow_class_const( |
58 | const struct bt_component *component); | |
47e5a032 | 59 | |
d3e4dcd8 | 60 | extern enum bt_component_class_type bt_component_get_class_type( |
7b53201c | 61 | const struct bt_component *component); |
d3e4dcd8 | 62 | |
543147fa | 63 | static inline |
7b53201c | 64 | bt_bool bt_component_is_source(const struct bt_component *component) |
543147fa PP |
65 | { |
66 | return bt_component_get_class_type(component) == | |
67 | BT_COMPONENT_CLASS_TYPE_SOURCE; | |
68 | } | |
69 | ||
70 | static inline | |
7b53201c | 71 | bt_bool bt_component_is_filter(const struct bt_component *component) |
543147fa PP |
72 | { |
73 | return bt_component_get_class_type(component) == | |
74 | BT_COMPONENT_CLASS_TYPE_FILTER; | |
75 | } | |
76 | ||
77 | static inline | |
7b53201c | 78 | bt_bool bt_component_is_sink(const struct bt_component *component) |
543147fa PP |
79 | { |
80 | return bt_component_get_class_type(component) == | |
81 | BT_COMPONENT_CLASS_TYPE_SINK; | |
82 | } | |
83 | ||
7b53201c PP |
84 | extern bt_bool bt_component_graph_is_canceled( |
85 | const struct bt_component *component); | |
f60c8b34 | 86 | |
43de0e13 JG |
87 | #ifdef __cplusplus |
88 | } | |
89 | #endif | |
90 | ||
7b53201c | 91 | #endif /* BABELTRACE_GRAPH_COMPONENT_CONST_H */ |