PlugIn Class Reference
Descriptive abstract interface to all plug-ins. More...
#include <PlugIn.h>
Public Member Functions | |
| virtual std::string | getVersion () const =0 |
| virtual bool | isProduction () const =0 |
| virtual std::string | getCreator () const =0 |
| virtual std::string | getCopyright () const =0 |
| virtual std::map< std::string, std::string > | getDependencyCopyright () const =0 |
| virtual std::string | getDescription () const =0 |
| virtual std::string | getShortDescription () const =0 |
| virtual std::string | getDescriptorId () const =0 |
| virtual std::string | getType () const =0 |
| virtual std::string | getSubtype () const =0 |
| virtual bool | areMultipleInstancesAllowed () const =0 |
| virtual bool | setId (const SessionItemId &id)=0 |
Protected Member Functions | |
| virtual | ~PlugIn () |
Detailed Description
Descriptive abstract interface to all plug-ins.Defines the descriptive abstract interface to all plug-ins. This interface is used to query all plug-ins for textual descriptive information.
- See also:
- SessionItem
Definition at line 29 of file PlugIn.h.
Constructor & Destructor Documentation
| virtual PlugIn::~PlugIn | ( | ) | [protected, virtual] |
This should be destroyed by calling PlugInManagerServices::destroyPlugIn.
Member Function Documentation
| virtual std::string PlugIn::getVersion | ( | ) | const [pure virtual] |
Returns the plug-in version.
This method returns the plug-in version as a string. For example, "1.1.1" is a valid version string.
- Returns:
- The plug-in version.
Implemented in PlugInShell.
| virtual bool PlugIn::isProduction | ( | ) | const [pure virtual] |
Returns the plug-in production status.
This method returns the plug-in production status as a bool.
- Returns:
- The plug-in production status.
Implemented in PlugInShell.
| virtual std::string PlugIn::getCreator | ( | ) | const [pure virtual] |
Returns the name of the organization that created the plug-in.
This method returns the string name of the organization responsible for creating the plug-in. For example, "Ball Aerospace & Technologies Corp." is a valid creator string.
- Returns:
- The organization that created the plug-in.
Implemented in PlugInShell.
| virtual std::string PlugIn::getCopyright | ( | ) | const [pure virtual] |
Returns the full copyright information for the plug-in.
- Returns:
- The copyright information for the plug-in.
Implemented in PlugInShell.
| virtual std::map<std::string, std::string> PlugIn::getDependencyCopyright | ( | ) | const [pure virtual] |
Returns copyright information for plug-in dependencies.
This information will appear in the About box. If information for a given dependency name already exists, it will not be replaced. The copyright message may be formatted with HTML markup.
- Returns:
- A map containing copyright information for dependencies. The key should be a short name for the dependency. (for example: libtiff) The value should be the verbatim copyright message for that plug-in.
Implemented in PlugInShell.
| virtual std::string PlugIn::getDescription | ( | ) | const [pure virtual] |
Returns a text description for the plug-in.
This method returns the full textual description for a plug-in. The description string is of arbitrary length.
- Returns:
- The full plug-in description.
- See also:
- getShortDescription()
Implemented in PlugInShell.
| virtual std::string PlugIn::getShortDescription | ( | ) | const [pure virtual] |
Returns a short description for the plug-in.
This method returns a short 50-charater or less description about the plug-in. This short description is used for brief descriptive table entries in the GUI.
- Returns:
- The short plug-in description.
- See also:
- getDescription()
Implemented in PlugInShell, and Nitf::TreParserShell.
| virtual std::string PlugIn::getDescriptorId | ( | ) | const [pure virtual] |
Returns a unique id for the type of plug-in.
This method returns a unique id for the plug-in class. This string should be formatted as a UUID. This value must be the same between instances of the application.
- Returns:
- The UUID
Implemented in PlugInShell.
| virtual std::string PlugIn::getType | ( | ) | const [pure virtual] |
Returns the plug-in type.
Default plug-in types include the following:
- PlugInManagerServices::AlgorithmType()
- PlugInManagerServices::ExporterType()
- PlugInManagerServices::GeoreferenceType()
- PlugInManagerServices::ImporterType()
- PlugInManagerServices::InterpreterType()
- PlugInManagerServices::OptionType()
- PlugInManagerServices::PropertiesType()
- PlugInManagerServices::RasterPagerType()
- PlugInManagerServices::ViewerType()
- PlugInManagerServices::WizardType()
- Returns:
- The plug-in type.
Implemented in PlugInShell.
| virtual std::string PlugIn::getSubtype | ( | ) | const [pure virtual] |
Returns the plug-in subtype.
Plug-ins can optionally define a subtype to further distinguish between multiple kinds of plug-ins with the same type, typically importers and exporters. The subtype is used internally to populate file selection dialogs so that they contain only a subset of plug-ins of a given type. Default plug-in subtypes include the following:
- Layer
- Model Element
- Product
- Raster Element
- Shape File
- Signature
- Signature Set
- Returns:
- The plug-in subtype. An empty string may be returned, indicating that the plug-in does not have a specific subtype.
- See also:
- getType()
Implemented in PlugInShell.
| virtual bool PlugIn::areMultipleInstancesAllowed | ( | ) | const [pure virtual] |
Queries whether multiple instances of the plug-in can be instantiated simultaneously.
If multiple instances of a plug-in are allowed, the plug-in should have no static variables and can have instance-independent input and output files.
- Returns:
- Returns true if the multiple instances of the plug-in can be created and executed simultaneously; otherwise returns false.
Implemented in PlugInShell.
| virtual bool PlugIn::setId | ( | const SessionItemId & | id | ) | [pure virtual] |
Sets the id of the session item.
This method will set the id of the item. It will only work if getId has not yet been called.
- Parameters:
-
id The new id for the SessionItem.
- Returns:
- Returns
trueif the id was successfully set, orfalseotherwise.
Implemented in PlugInShell.