moveit2
The MoveIt Motion Planning Framework for ROS 2.
templates.hpp
Go to the documentation of this file.
1 /*********************************************************************
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2021, PickNik Robotics, 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 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 
39 #include <string>
40 
41 namespace moveit_setup
42 {
47 {
48  TemplateVariable(const std::string& key, const std::string& value) : key(key), value(value)
49  {
50  }
51 
52  std::string key;
53  std::string value;
54 };
55 
60 {
61 public:
62  // Use same constructor
64 
68  virtual std::filesystem::path getTemplatePath() const = 0;
69 
70  bool write() override;
71 
72  static std::vector<TemplateVariable> variables;
73 };
74 
75 } // namespace moveit_setup
Container for the logic for a single file to appear in MoveIt configuration package.
GeneratedFile(const GeneratedFile &)=default
Specialization of GeneratedFile for generating a text file from a template.
Definition: templates.hpp:60
virtual std::filesystem::path getTemplatePath() const =0
Returns the full path to the template file.
static std::vector< TemplateVariable > variables
Definition: templates.hpp:72
bool write() override
Writes the file to disk.
Definition: templates.cpp:53
Simple Key/value pair for templates.
Definition: templates.hpp:47
TemplateVariable(const std::string &key, const std::string &value)
Definition: templates.hpp:48