PluginInfo.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
3 
4  This file is part of the TerraLib - a Framework for building GIS enabled applications.
5 
6  TerraLib is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License,
9  or (at your option) any later version.
10 
11  TerraLib is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with TerraLib. See COPYING. If not, write to
18  TerraLib Team at <terralib-team@terralib.org>.
19  */
20 
21 /*!
22  \file terralib/core/plugin/PluginInfo.h
23 
24  \brief The basic information about a plugin.
25 
26  \author Gilberto Ribeiro de Queiroz
27  \author Matheus Cavassan Zaglia
28  */
29 
30 #ifndef __TERRALIB_CORE_PLUGIN_PLUGININFO_H__
31 #define __TERRALIB_CORE_PLUGIN_PLUGININFO_H__
32 
33 // STL
34 #include <string>
35 #include <utility>
36 #include <vector>
37 
38 namespace te
39 {
40  namespace core
41  {
42 
43  /*! Describe the plugin provider. */
44  struct Provider
45  {
46  std::string name; //!< Provider name: may be a person or a company.
47  std::string site; //!< The provider home page.
48  std::string email; //!< The provider contact e-mail.
49  };
50 
51  /*! \brief Describe the host system */
52  struct HostApplication
53  {
54  std::string name;
55  std::string version;
56  };
57 
58  typedef std::pair<std::string, std::string> Resource;
59 
60  typedef std::pair<std::string, std::string> Parameter;
61 
62  /*! \brief Basic information about a plugin. */
63  struct PluginInfo
64  {
65  std::string name; //!< The plugin name: an internal value used to identify the plugin in the system. Must be a unique value.
66  std::string display_name; //!< The plugin name to be displayed in a graphical interface.
67  std::string description; //!< A brief explanation about the plugin.
68  std::string version; //!< The plugin version.
69  std::string release; //!< The release date of the plugin. This may be used to identify new versions of a given plugin.
70  std::string engine; //!< The type of plugin execution engine: C++, JAVA, LUA or any other supported engine.
71  std::string license_description; //!< A brief description about the plugin license.
72  std::string license_URL; //!< An URL where someone can find more information on the license.
73  std::string site; //!< An URL pointing to the plugin site.
74  Provider provider; //!< Information about the plugin provider.
75  std::vector<std::string> dependencies; //!< The list of required plugins in order to launch the plugin.
76  std::vector<std::string> linked_libraries; //!< The list of linked libraries.
77  std::vector<Resource> resources; //!< The list of resources used by plugin.
78  std::vector<Parameter> parameters; //!< Any configuration parameter that can be informed to plugin (map: parameter-name -> parameter-value).
79  HostApplication host_application; //!< Information about the host system. May be used to validate the plugin version.
80  };
81 
82  } // end namespace core
83 } // end namespace te
84 
85 #endif // __TERRALIB_CORE_PLUGIN_PLUGININFO_H__
std::string license_description
A brief description about the plugin license.
Definition: PluginInfo.h:71
std::string email
The provider contact e-mail.
Definition: LibraryInfo.h:50
std::string engine
The type of plugin execution engine: C++, JAVA, LUA or any other supported engine.
Definition: PluginInfo.h:70
std::pair< std::string, std::string > Resource
Definition: LibraryInfo.h:60
HostApplication host_application
Information about the host system. May be used to validate the plugin version.
Definition: PluginInfo.h:79
Basic information about a plugin.
Definition: PluginInfo.h:63
std::vector< Resource > resources
The list of resources used by plugin.
Definition: PluginInfo.h:77
std::string site
The provider home page.
Definition: LibraryInfo.h:49
std::string description
A brief explanation about the plugin.
Definition: PluginInfo.h:67
std::string display_name
The plugin name to be displayed in a graphical interface.
Definition: PluginInfo.h:66
std::pair< std::string, std::string > Parameter
Definition: LibraryInfo.h:62
std::string name
The plugin name: an internal value used to identify the plugin in the system. Must be a unique value...
Definition: PluginInfo.h:65
std::string name
Provider name: may be a person or a company.
Definition: LibraryInfo.h:48
Describe the host system.
Definition: LibraryInfo.h:54
URI C++ Library.
std::vector< std::string > dependencies
The list of required plugins in order to launch the plugin.
Definition: PluginInfo.h:75
std::vector< Parameter > parameters
Any configuration parameter that can be informed to plugin (map: parameter-name -> parameter-value)...
Definition: PluginInfo.h:78
std::string license_URL
An URL where someone can find more information on the license.
Definition: PluginInfo.h:72
std::string release
The release date of the plugin. This may be used to identify new versions of a given plugin...
Definition: PluginInfo.h:69
std::string site
An URL pointing to the plugin site.
Definition: PluginInfo.h:73
std::vector< std::string > linked_libraries
The list of linked libraries.
Definition: PluginInfo.h:76
std::string version
The plugin version.
Definition: PluginInfo.h:68
Describe the module provider.
Definition: LibraryInfo.h:46
Provider provider
Information about the plugin provider.
Definition: PluginInfo.h:74