moveit2
The MoveIt Motion Planning Framework for ROS 2.
author_information.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 
41 namespace moveit_setup
42 {
43 namespace core
44 {
46 {
47 public:
48  std::string getName() const override
49  {
50  return "Author Information";
51  }
52 
53  void onInit() override;
54 
55  bool isReady() const override
56  {
57  return true; // always ready, no dependencies
58  }
59 
60  // Note, we use getAuthorName instead of getName because getName is defined above
61  std::string getAuthorName() const;
62  std::string getAuthorEmail() const;
63  void setAuthorName(const std::string& name);
64  void setAuthorEmail(const std::string& email);
65 
66 protected:
67  std::shared_ptr<PackageSettingsConfig> package_settings_;
68 };
69 } // namespace core
70 } // namespace moveit_setup
Contains all of the non-GUI code necessary for doing one "screen" worth of setup.
Definition: setup_step.hpp:47
void setAuthorEmail(const std::string &email)
std::string getName() const override
Returns the name of the setup step.
std::shared_ptr< PackageSettingsConfig > package_settings_
void onInit() override
Overridable initialization method.
void setAuthorName(const std::string &name)
bool isReady() const override
Return true if the data necessary to proceed with this step has been configured.
name
Definition: setup.py:7