moveit2
The MoveIt Motion Planning Framework for ROS 2.
plan_responses_container.hpp
Go to the documentation of this file.
1 /*********************************************************************
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2023, PickNik Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  * copyright notice, this list of conditions and the following
15  * disclaimer in the documentation and/or other materials provided
16  * with the distribution.
17  * * Neither the name of PickNik Inc. nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *********************************************************************/
34 
35 /* Author: Sebastian Jahr
36  Desc: A thread safe container to store motion plan responses */
37 
38 #pragma once
39 
42 
43 namespace moveit
44 {
45 namespace planning_pipeline_interfaces
46 {
47 MOVEIT_CLASS_FORWARD(PlanResponsesContainer); // Defines PlanningComponentPtr, ConstPtr, WeakPtr... etc
50 {
51 public:
55  PlanResponsesContainer(const size_t expected_size = 0);
56 
62  void pushBack(const ::planning_interface::MotionPlanResponse& plan_solution);
63 
67  const std::vector<::planning_interface::MotionPlanResponse>& getSolutions() const;
68 
69 private:
70  std::vector<::planning_interface::MotionPlanResponse> solutions_;
71  std::mutex solutions_mutex_;
72 };
73 } // namespace planning_pipeline_interfaces
74 } // namespace moveit
A container to thread-safely store multiple MotionPlanResponses.
const std::vector<::planning_interface::MotionPlanResponse > & getSolutions() const
Get solutions.
void pushBack(const ::planning_interface::MotionPlanResponse &plan_solution)
Thread safe method to add PlanResponsesContainer to this data structure TODO(sjahr): Refactor this me...
MOVEIT_CLASS_FORWARD(PlanResponsesContainer)
Main namespace for MoveIt.
Definition: exceptions.h:43