The basic information about a plugin. More...

#include <PluginInfo.h>

Classes
struct	Finder1st

Public Types
typedef std::pair< std::string, std::string >	Parameter

typedef std::pair< std::string, std::string >	Resource

Public Member Functions
bool	operator< (const PluginInfo &rhs) const
	This overloaded operator can be used to index the plugin info in a set. More...

Public Attributes
std::string	m_category
	The plugin category. More...

std::string	m_description
	A brief explanation about the plugin. More...

std::string	m_displayName
	The plugin name to be displayed in a graphical interface. More...

std::string	m_engine
	The type of plugin execution engine: C++, JAVA. More...

std::string	m_folder
	The plugin folder (where the plugin is installed). More...

std::string	m_licenseDescription
	A brief description about the plugin license. More...

std::string	m_licenseURL
	An URL where someone can find more information on the license. More...

std::string	m_name
	The plugin name: an internal value used to identify the plugin in the system. Must be a unique value. More...

std::vector< Parameter >	m_parameters
	Any configuration parameter that can be informed to plugin (map: parameter-name -> parameter-value). More...

Provider	m_provider
	Information about the plugin provider. More...

std::string	m_release
	The release date of the plugin. This may be used to identify new versions of a given plugin. More...

std::vector< std::string >	m_requiredModules
	The list of required category of plugins in order to lunch the plugin. More...

std::vector< std::string >	m_requiredPluginCategories
	The list of required category of plugins in order to lunch the plugin. More...

std::vector< std::string >	m_requiredPlugins
	The list of required plugins in order to lunch the plugin. More...

std::vector< Resource >	m_resources
	The list of resources used by plugin. More...

std::string	m_site
	An URL pointing to the plugin site. More...

std::string	m_terralibVersion
	The TerraLib version this plugin depends on. More...

std::string	m_version
	The plugin version. More...

Detailed Description

The basic information about a plugin.

See Also: Plugin

Note

There are some special plugins categories:

Data Access
Unknown Category
Language Bindings

Definition at line 61 of file PluginInfo.h.

Member Typedef Documentation

typedef std::pair<std::string, std::string> te::plugin::PluginInfo::Parameter

Definition at line 64 of file PluginInfo.h.

typedef std::pair<std::string, std::string> te::plugin::PluginInfo::Resource

Definition at line 63 of file PluginInfo.h.

Member Function Documentation

bool te::plugin::PluginInfo::operator< ( const PluginInfo & rhs ) const

inline

This overloaded operator can be used to index the plugin info in a set.

Parameters

rhs	The right-hand-side plugin info.

Returns: True if this plugin name is lexcographical less than the rhs plugin name.

Definition at line 92 of file PluginInfo.h.

References m_name.

Member Data Documentation

std::string te::plugin::PluginInfo::m_category

The plugin category.

Definition at line 75 of file PluginInfo.h.

Referenced by te::qt::widgets::PluginBuilderWizard::buildPlugin(), te::qt::widgets::PluginCMakeWriter::createPluginInfoFile(), te::plugin::PluginManager::detach(), GetData(), te::plugin::Module::initialize(), te::plugin::PluginManager::load(), operator<<(), and te::plugin::PluginManager::unload().

std::string te::plugin::PluginInfo::m_description

A brief explanation about the plugin.

Definition at line 68 of file PluginInfo.h.

Referenced by te::qt::widgets::PluginBuilderWizard::buildPlugin(), te::qt::widgets::PluginCMakeWriter::createPluginInfoFile(), te::tools::dscopy::Utils::loadModules(), Utils::loadModules(), te::tools::rastermanager::Utils::loadModules(), te::idl::loadTerralibModules(), and operator<<().

std::string te::plugin::PluginInfo::m_displayName

The plugin name to be displayed in a graphical interface.

Definition at line 67 of file PluginInfo.h.

Referenced by te::qt::widgets::PluginBuilderWizard::buildPlugin(), te::qt::widgets::PluginCMakeWriter::createPluginInfoFile(), GetData(), te::idl::loadTerralibModules(), and operator<<().

std::string te::plugin::PluginInfo::m_engine

The type of plugin execution engine: C++, JAVA.

Definition at line 71 of file PluginInfo.h.

Referenced by te::qt::widgets::PluginBuilderWizard::buildPlugin(), te::qt::widgets::PluginCMakeWriter::createPluginInfoFile(), te::plugin::Module::initialize(), te::plugin::PluginManager::load(), te::idl::loadTerralibModules(), operator<<(), te::plugin::CppPluginEngine::unload(), te::plugin::PluginManager::unload(), and te::plugin::UnloadAllPluginsFromEngine().

std::string te::plugin::PluginInfo::m_folder

The plugin folder (where the plugin is installed).

Definition at line 78 of file PluginInfo.h.

Referenced by te::qt::widgets::PluginBuilderWizard::buildPlugin(), te::plugin::CppPluginEngine::load(), te::plugin::PluginManager::load(), and te::qt::af::UpdateApplicationPlugins().

std::string te::plugin::PluginInfo::m_licenseDescription

A brief description about the plugin license.

Definition at line 73 of file PluginInfo.h.

Referenced by te::qt::widgets::PluginBuilderWizard::buildPlugin(), te::qt::widgets::PluginCMakeWriter::createPluginInfoFile(), GetData(), and operator<<().

std::string te::plugin::PluginInfo::m_licenseURL

An URL where someone can find more information on the license.

Definition at line 74 of file PluginInfo.h.

Referenced by te::qt::widgets::PluginBuilderWizard::buildPlugin(), te::qt::widgets::PluginCMakeWriter::createPluginInfoFile(), and operator<<().

std::string te::plugin::PluginInfo::m_name

The plugin name: an internal value used to identify the plugin in the system. Must be a unique value.

Definition at line 66 of file PluginInfo.h.

Referenced by te::qt::widgets::PluginManagerDialog::addEntry(), AddPlugin(), te::qt::widgets::PluginBuilderWizard::buildPlugin(), CheckLoadedDependencies(), CheckRequiredDependencies(), te::qt::widgets::PluginCMakeWriter::createPluginInfoFile(), te::qt::widgets::PluginManagerDialog::fillInstalledPlugins(), GetData(), te::plugin::Module::initialize(), te::plugin::CppPluginEngine::load(), te::plugin::PluginManager::load(), te::tools::dscopy::Utils::loadModules(), Utils::loadModules(), te::tools::rastermanager::Utils::loadModules(), te::idl::loadTerralibModules(), te::plugin::PluginManager::moveDependentsToBrokenList(), operator<(), operator<<(), te::plugin::PluginManager::removeFromBrokenList(), te::plugin::PluginManager::removeFromUnloadedList(), te::plugin::PluginManager::unload(), and te::qt::af::UpdateApplicationPlugins().

std::vector<Parameter> te::plugin::PluginInfo::m_parameters

Any configuration parameter that can be informed to plugin (map: parameter-name -> parameter-value).

Definition at line 83 of file PluginInfo.h.

Referenced by te::qt::widgets::PluginBuilderWizard::buildPlugin(), te::qt::widgets::PluginCMakeWriter::createPluginInfoFile(), and operator<<().

Provider te::plugin::PluginInfo::m_provider

Information about the plugin provider.

Definition at line 77 of file PluginInfo.h.

Referenced by GetData(), and operator<<().

std::string te::plugin::PluginInfo::m_release

The release date of the plugin. This may be used to identify new versions of a given plugin.

Definition at line 70 of file PluginInfo.h.

Referenced by te::qt::widgets::PluginBuilderWizard::buildPlugin(), te::qt::widgets::PluginCMakeWriter::createPluginInfoFile(), and operator<<().

std::vector<std::string> te::plugin::PluginInfo::m_requiredModules

The list of required category of plugins in order to lunch the plugin.

Definition at line 81 of file PluginInfo.h.

Referenced by te::qt::widgets::PluginBuilderWizard::buildPlugin(), te::qt::widgets::PluginCMakeWriter::createPluginInfoFile(), te::qt::widgets::PluginCMakeWriter::findTerralib(), and operator<<().

std::vector<std::string> te::plugin::PluginInfo::m_requiredPluginCategories

The list of required category of plugins in order to lunch the plugin.

Definition at line 80 of file PluginInfo.h.

Referenced by te::qt::widgets::PluginBuilderWizard::buildPlugin(), and operator<<().

std::vector<std::string> te::plugin::PluginInfo::m_requiredPlugins

The list of required plugins in order to lunch the plugin.

Definition at line 79 of file PluginInfo.h.

Referenced by te::qt::widgets::PluginBuilderWizard::buildPlugin(), CheckRequiredDependencies(), te::qt::widgets::PluginCMakeWriter::createPluginInfoFile(), te::plugin::PluginManager::load(), and operator<<().

std::vector<Resource> te::plugin::PluginInfo::m_resources

The list of resources used by plugin.

Definition at line 82 of file PluginInfo.h.

Referenced by te::qt::widgets::PluginBuilderWizard::buildPlugin(), te::qt::widgets::PluginCMakeWriter::createPluginInfoFile(), te::plugin::Module::initialize(), te::plugin::CppPluginEngine::load(), te::idl::loadTerralibModules(), and operator<<().

std::string te::plugin::PluginInfo::m_site

An URL pointing to the plugin site.

Definition at line 76 of file PluginInfo.h.

Referenced by te::qt::widgets::PluginBuilderWizard::buildPlugin(), te::qt::widgets::PluginCMakeWriter::createPluginInfoFile(), GetData(), and operator<<().

std::string te::plugin::PluginInfo::m_terralibVersion

The TerraLib version this plugin depends on.

Definition at line 72 of file PluginInfo.h.

Referenced by te::qt::widgets::PluginBuilderWizard::buildPlugin(), te::qt::widgets::PluginCMakeWriter::createPluginInfoFile(), and operator<<().

std::string te::plugin::PluginInfo::m_version

The plugin version.

Definition at line 69 of file PluginInfo.h.

Referenced by te::qt::widgets::PluginBuilderWizard::buildPlugin(), te::qt::widgets::PluginCMakeWriter::createPluginInfoFile(), GetData(), and operator<<().

The documentation for this struct was generated from the following file:

/home/castejon/castejon_files/develop/terralib5/git/src/terralib/plugin/PluginInfo.h

Classes

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

Member Function Documentation

Member Data Documentation