Gazebo Common

API Reference

3.17.0
gz/common/PluginInfo.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2017 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 
18 
19 #ifndef GZ_COMMON_PLUGININFO_HH_
20 #define GZ_COMMON_PLUGININFO_HH_
21 
22 #include <functional>
23 #include <string>
24 #include <unordered_map>
25 
26 namespace ignition
27 {
28  namespace common
29  {
32  //
34  const int PLUGIN_API_VERSION = 1;
35 
36 
38  struct PluginInfo
39  {
42 
48  using InterfaceCastingMap =
51 
54 
56  std::function<void(void*)> deleter;
57  };
58  }
59 }
60 
61 #endif
Forward declarations for the common classes.
STL class.
std::function< void *()> factory
A method that instantiates a new instance of a plugin.
Definition: gz/common/PluginInfo.hh:53
std::function< void(void *)> deleter
A method that safely deletes an instance of the plugin.
Definition: gz/common/PluginInfo.hh:56
Holds info required to construct a plugin.
Definition: gz/common/PluginInfo.hh:38
std::string name
The name of the plugin.
Definition: gz/common/PluginInfo.hh:41
InterfaceCastingMap interfaces
Definition: gz/common/PluginInfo.hh:50
const int PLUGIN_API_VERSION
sentinel value to check if a plugin was built with the same version of the PluginInfo struct
Definition: gz/common/PluginInfo.hh:34