The base class for a callback group. More...
Public Member Functions | |
| __init__ (self) | |
| add_entity (self, entity) | |
| Adds an entity to this group. | |
| beginning_execution (self, entity) | |
| Returns True (ROS2 compatibility stand-in). | |
| can_execute (self, entity) | |
| Returns True (ROS2 compatibility stand-in). | |
| ending_execution (self, entity) | |
| Does nothing (ROS2 compatibility stand-in). | |
| has_entity (self, entity) | |
| Returns whether an entity has been added to this group. | |
Public Attributes | |
| entities | |
Detailed Description
The base class for a callback group.
A callback group controls when callbacks are allowed to be executed.
This class should not be instantiated. Instead, classes should extend it and implement :meth:`can_execute`, :meth:`beginning_execution`, and :meth:`ending_execution`.
Definition at line 26 of file callback_groups.py.
Constructor & Destructor Documentation
◆ __init__()
| rosros.rclify.callback_groups.CallbackGroup.__init__ | ( | self | ) |
Definition at line 28 of file callback_groups.py.
Member Function Documentation
◆ add_entity()
| rosros.rclify.callback_groups.CallbackGroup.add_entity | ( | self, | |
| entity | |||
| ) |
Adds an entity to this group.
Definition at line 31 of file callback_groups.py.
◆ beginning_execution()
| rosros.rclify.callback_groups.CallbackGroup.beginning_execution | ( | self, | |
| entity | |||
| ) |
Returns True (ROS2 compatibility stand-in).
Definition at line 43 of file callback_groups.py.
◆ can_execute()
| rosros.rclify.callback_groups.CallbackGroup.can_execute | ( | self, | |
| entity | |||
| ) |
Returns True (ROS2 compatibility stand-in).
Definition at line 39 of file callback_groups.py.
◆ ending_execution()
| rosros.rclify.callback_groups.CallbackGroup.ending_execution | ( | self, | |
| entity | |||
| ) |
Does nothing (ROS2 compatibility stand-in).
Definition at line 47 of file callback_groups.py.
◆ has_entity()
| rosros.rclify.callback_groups.CallbackGroup.has_entity | ( | self, | |
| entity | |||
| ) |
Returns whether an entity has been added to this group.
Definition at line 35 of file callback_groups.py.
Member Data Documentation
◆ entities
| rosros.rclify.callback_groups.CallbackGroup.entities |
Definition at line 29 of file callback_groups.py.
The documentation for this class was generated from the following file:
- rosros/rclify/callback_groups.py
