1 #ifndef BABELTRACE_GRAPH_COMPONENT_CONST_H
2 #define BABELTRACE_GRAPH_COMPONENT_CONST_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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
27 /* For enum bt_component_class_type */
28 #include <babeltrace/graph/component-class-const.h>
31 #include <babeltrace/types.h>
37 struct bt_component_class
;
38 struct bt_component_graph
;
44 * Get component's name.
46 * @param component Component instance of which to get the name
47 * @returns Returns a pointer to the component's name
49 extern const char *bt_component_get_name(const struct bt_component
*component
);
52 * Get component's class.
54 * @param component Component instance of which to get the class
55 * @returns The component's class
57 extern const struct bt_component_class
*bt_component_borrow_class_const(
58 const struct bt_component
*component
);
60 extern enum bt_component_class_type
bt_component_get_class_type(
61 const struct bt_component
*component
);
64 bt_bool
bt_component_is_source(const struct bt_component
*component
)
66 return bt_component_get_class_type(component
) ==
67 BT_COMPONENT_CLASS_TYPE_SOURCE
;
71 bt_bool
bt_component_is_filter(const struct bt_component
*component
)
73 return bt_component_get_class_type(component
) ==
74 BT_COMPONENT_CLASS_TYPE_FILTER
;
78 bt_bool
bt_component_is_sink(const struct bt_component
*component
)
80 return bt_component_get_class_type(component
) ==
81 BT_COMPONENT_CLASS_TYPE_SINK
;
84 extern bt_bool
bt_component_graph_is_canceled(
85 const struct bt_component
*component
);
91 #endif /* BABELTRACE_GRAPH_COMPONENT_CONST_H */