Gazebo Common

API Reference

4.7.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 IGNITION_COMMON_PLUGININFO_HH_
20 #define IGNITION_COMMON_PLUGININFO_HH_
21 
22 #include <functional>
23 #include <string>
24 #include <unordered_map>
25 
26 #include <gz/common/config.hh>
27 
28 namespace ignition
29 {
30  namespace common
31  {
34  //
36  const int PLUGIN_API_VERSION = 1;
37 
38 
40  struct PluginInfo
41  {
44 
50  using InterfaceCastingMap =
53 
56 
58  std::function<void(void*)> deleter;
59  };
60  }
61 }
62 
63 #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:55
std::function< void(void *)> deleter
A method that safely deletes an instance of the plugin.
Definition: gz/common/PluginInfo.hh:58
Holds info required to construct a plugin.
Definition: gz/common/PluginInfo.hh:40
std::string name
The name of the plugin.
Definition: gz/common/PluginInfo.hh:43
InterfaceCastingMap interfaces
Definition: gz/common/PluginInfo.hh:52
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:36