1 #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_H
2 #define BABELTRACE_GRAPH_COMPONENT_CLASS_H
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 #include <babeltrace/types.h>
33 struct bt_component_class
;
35 enum bt_component_class_type
{
36 BT_COMPONENT_CLASS_TYPE_SOURCE
= 0,
37 BT_COMPONENT_CLASS_TYPE_FILTER
= 1,
38 BT_COMPONENT_CLASS_TYPE_SINK
= 2,
41 extern const char *bt_component_class_get_name(
42 struct bt_component_class
*component_class
);
44 extern const char *bt_component_class_get_description(
45 struct bt_component_class
*component_class
);
47 extern const char *bt_component_class_get_help(
48 struct bt_component_class
*component_class
);
50 extern enum bt_component_class_type
bt_component_class_get_type(
51 struct bt_component_class
*component_class
);
54 bt_bool
bt_component_class_is_source(struct bt_component_class
*component_class
)
56 return bt_component_class_get_type(component_class
) ==
57 BT_COMPONENT_CLASS_TYPE_SOURCE
;
61 bt_bool
bt_component_class_is_filter(struct bt_component_class
*component_class
)
63 return bt_component_class_get_type(component_class
) ==
64 BT_COMPONENT_CLASS_TYPE_FILTER
;
68 bt_bool
bt_component_class_is_sink(struct bt_component_class
*component_class
)
70 return bt_component_class_get_type(component_class
) ==
71 BT_COMPONENT_CLASS_TYPE_SINK
;
78 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_H */