moveit2
The MoveIt Motion Planning Framework for ROS 2.
Loading...
Searching...
No Matches
simulation.hpp
Go to the documentation of this file.
1/*********************************************************************
2 * Software License Agreement (BSD License)
3 *
4 * Copyright (c) 2021, PickNik Robotics
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 Robotics 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: David V. Lu!! */
36#pragma once
37
40
41namespace moveit_setup
42{
43namespace simulation
44{
45class Simulation : public SetupStep
46{
47public:
48 std::string getName() const override
49 {
50 return "Simulation";
51 }
52
53 void onInit() override;
54
55 bool isReady() const override
56 {
57 return false;
58 }
59
60 std::filesystem::path getURDFPath() const
61 {
62 return urdf_config_->getURDFPath();
63 }
64
65 std::string getURDFPackageName() const
66 {
67 return urdf_config_->getURDFPackageName();
68 }
69
70 std::string getURDFContents() const
71 {
72 return urdf_config_->getURDFContents();
73 }
74
79 std::string getJointHardwareInterface(const std::string& joint_name);
80
86 std::string getGazeboCompatibleURDF();
87
88 bool outputGazeboURDFFile(const std::filesystem::path& file_path);
89
97 bool isValidXML(const std::string& new_urdf_contents, int& error_row, std::string& error_description) const;
98
99protected:
100 std::shared_ptr<URDFConfig> urdf_config_;
101
103 // NOTE: Created when the robot urdf is not compatible with Gazebo.
105
108};
109} // namespace simulation
110} // namespace moveit_setup
Contains all of the non-GUI code necessary for doing one "screen" worth of setup.
std::string gazebo_urdf_string_
Gazebo URDF robot model string.
void onInit() override
Overridable initialization method.
std::filesystem::path getURDFPath() const
std::string getURDFPackageName() const
std::shared_ptr< URDFConfig > urdf_config_
std::string getName() const override
Returns the name of the setup step.
bool save_gazebo_urdf_
Whether a new Gazebo URDF is created.
bool isValidXML(const std::string &new_urdf_contents, int &error_row, std::string &error_description) const
Check if the given xml is valid.
bool outputGazeboURDFFile(const std::filesystem::path &file_path)
bool isReady() const override
Return true if the data necessary to proceed with this step has been configured.
std::string getGazeboCompatibleURDF()
Parses the existing urdf and constructs a string from it with the elements required by gazebo simulat...
std::string getJointHardwareInterface(const std::string &joint_name)
Helper function to get the controller that is controlling the joint.