moveit2
The MoveIt Motion Planning Framework for ROS 2.
moveit_setup_assistant
moveit_setup_core_plugins
include
moveit_setup_core_plugins
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
38
#include <
moveit_setup_framework/setup_step.hpp
>
39
#include <
moveit_setup_framework/data/package_settings_config.hpp
>
40
41
namespace
moveit_setup
42
{
43
namespace
core
44
{
45
class
AuthorInformation
:
public
SetupStep
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
moveit_setup::SetupStep
Contains all of the non-GUI code necessary for doing one "screen" worth of setup.
Definition:
setup_step.hpp:47
moveit_setup::core::AuthorInformation
Definition:
author_information.hpp:46
moveit_setup::core::AuthorInformation::setAuthorEmail
void setAuthorEmail(const std::string &email)
Definition:
author_information.cpp:63
moveit_setup::core::AuthorInformation::getName
std::string getName() const override
Returns the name of the setup step.
Definition:
author_information.hpp:48
moveit_setup::core::AuthorInformation::package_settings_
std::shared_ptr< PackageSettingsConfig > package_settings_
Definition:
author_information.hpp:67
moveit_setup::core::AuthorInformation::onInit
void onInit() override
Overridable initialization method.
Definition:
author_information.cpp:43
moveit_setup::core::AuthorInformation::getAuthorName
std::string getAuthorName() const
Definition:
author_information.cpp:48
moveit_setup::core::AuthorInformation::setAuthorName
void setAuthorName(const std::string &name)
Definition:
author_information.cpp:58
moveit_setup::core::AuthorInformation::getAuthorEmail
std::string getAuthorEmail() const
Definition:
author_information.cpp:53
moveit_setup::core::AuthorInformation::isReady
bool isReady() const override
Return true if the data necessary to proceed with this step has been configured.
Definition:
author_information.hpp:55
moveit_setup
Definition:
launch_bundle.hpp:42
setup.name
name
Definition:
setup.py:7
package_settings_config.hpp
setup_step.hpp
Generated by
1.9.1