IsGripperHolding Class
Succeeds when the gripper's fingers stopped between fully open and fully closed, as they do on an object. More...
Declaration
Included Headers
Base class
| class | AsyncBehaviorBase |
|
A base class for behaviors which need to asynchronously run a function that might take a long time to complete. More... | |
Public Member Functions Index
| AsyncBehaviorBase (const std::string &name, const BT::NodeConfiguration &config, const std::shared_ptr< BehaviorContext > &shared_resources) | |
Private Member Functions Index
| tl::expected< bool, std::string > | doWork () override |
|
User-implemented function which handles executing the potentially-long-running process. More... | |
| std::shared_future< tl::expected< bool, std::string > > & | getFuture () override |
|
Gets the shared future which is used to monitor the progress of the async process. More... | |
Private Member Attributes Index
| std::shared_future< tl::expected< bool, std::string > > | future_ |
|
Classes derived from AsyncBehaviorBase must have this shared_future as a class member. More... | |
Public Static Functions Index
| static BT::PortsList | providedPorts () |
| static BT::KeyValueVector | metadata () |
Description
Succeeds when the gripper's fingers stopped between fully open and fully closed, as they do on an object.
Fails when the gripper has closed on nothing, or has lost what it held and closed the rest of the way. It reads the gripper's joint from the one group in the robot's SRDF with open and close states, and its position from the planning scene. An object thin enough to close the fingers within a tenth of their travel of closed, or within 1 mm for a sliding finger where that is less, reads as nothing. With expected false it succeeds on an empty hand.
| Data Port Name | Port Type | Object Type |
|---|---|---|
| planning_scene_msg | input | moveit_msgs::msg::PlanningScene |
| expected | input | bool |
Definition at line 74 of file is_gripper_holding.hpp.
Public Member Functions
AsyncBehaviorBase()
|
Declaration at line 77 of file is_gripper_holding.hpp, definition at line 12 of file async_behavior_base.cpp.
Private Member Functions
doWork()
| virtual |
User-implemented function which handles executing the potentially-long-running process.
This function is called within an async process in a separate thread.
- Returns
A tl::expected which contains a bool indicating task success if the process completed successfully or was canceled, or an error message if the process failed unexpectedly.
Declaration at line 84 of file is_gripper_holding.hpp, definition at line 173 of file is_gripper_holding.cpp.
getFuture()
| inline virtual |
Gets the shared future which is used to monitor the progress of the async process.
Classes derived from AsyncBehaviorBase must implement getFuture() so that it returns a shared_future class member.
This exists to prevent destruction of the derived class while the async process is still in-progress. If the derived class is destroyed, the definitions of the functions used within doWork() will be destroyed too, which will result in the virtual functions in the base class being called instead and cause a fault.
This function will force derived classes to add an instance of this type and return a reference to it. The base class can then use this virtual function to access the shared future in functions like onStart.
By adding this virtual function we're properly demonstrating how this future depends on things from the derived class and the natural flow of object lifetimes will do the hard work for us. The std::shared_future destructor will get the value of the future before the derived class is destructed assuming it's the last reference to the shared state. Doing it this way means neither the base nor derived class should need to implement a destructor which is a nice property to have.
- Returns
Returns the shared_future, which should be owned by the child class.
Definition at line 86 of file is_gripper_holding.hpp.
Private Member Attributes
future_
|
Classes derived from AsyncBehaviorBase must have this shared_future as a class member.
Definition at line 92 of file is_gripper_holding.hpp.
Public Static Functions
metadata()
| static |
Declaration at line 81 of file is_gripper_holding.hpp, definition at line 166 of file is_gripper_holding.cpp.
providedPorts()
| static |
Declaration at line 79 of file is_gripper_holding.hpp, definition at line 158 of file is_gripper_holding.cpp.
The documentation for this class was generated from the following files:
Generated via doxygen2docusaurus 2.2.2 by Doxygen 1.15.0.