PlugInDescriptor Class Reference
Caches plug-in metadata returned from the Importer, Exporter, Testable, Interpreter, Executable, and PlugIn interfaces. More...
#include <PlugInDescriptor.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 | getType () const =0 |
| virtual std::string | getSubtype () const =0 |
| virtual bool | areMultipleInstancesAllowed () const =0 |
| virtual bool | isExecutedOnStartup () const =0 |
| virtual bool | isDestroyedAfterExecute () const =0 |
| virtual const std::vector < std::string > & | getMenuLocations () const =0 |
| virtual bool | hasAbort () const =0 |
| virtual bool | hasBatchSupport () const =0 |
| virtual bool | hasInteractiveSupport () const =0 |
| virtual bool | hasWizardSupport () const =0 |
| virtual const PlugInArgList * | getBatchInputArgList () const =0 |
| virtual const PlugInArgList * | getInteractiveInputArgList () const =0 |
| virtual const PlugInArgList * | getBatchOutputArgList () const =0 |
| virtual const PlugInArgList * | getInteractiveOutputArgList () const =0 |
| virtual std::string | getFileExtensions () const =0 |
| virtual bool | isTestable () const =0 |
Protected Member Functions | |
| virtual | ~PlugInDescriptor () |
Detailed Description
Caches plug-in metadata returned from the Importer, Exporter, Testable, Interpreter, Executable, and PlugIn interfaces.This class provides metadata without ever instantiating the plug-in.
Definition at line 28 of file PlugInDescriptor.h.
Constructor & Destructor Documentation
| virtual PlugInDescriptor::~PlugInDescriptor | ( | ) | [protected, virtual] |
This will be cleaned up during application close.
Plug-ins do not need to destroy it.
Definition at line 230 of file PlugInDescriptor.h.
Member Function Documentation
| virtual std::string PlugInDescriptor::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.
| virtual bool PlugInDescriptor::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.
| virtual std::string PlugInDescriptor::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.
| virtual std::string PlugInDescriptor::getCopyright | ( | ) | const [pure virtual] |
Returns the full copyright information for the plug-in.
- Returns:
- The copyright information for the plug-in.
| virtual std::map<std::string, std::string> PlugInDescriptor::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.
| virtual std::string PlugInDescriptor::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()
| virtual std::string PlugInDescriptor::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()
| virtual std::string PlugInDescriptor::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.
| virtual std::string PlugInDescriptor::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()
| virtual bool PlugInDescriptor::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.
| virtual bool PlugInDescriptor::isExecutedOnStartup | ( | ) | const [pure virtual] |
Queries the value of Executable::isExecutedOnStartup() for Executable plug-ins.
- Returns:
- Returns the value provided by Executable::isExecutedOnStartup() or false if the plug-in is not of type Executable.
| virtual bool PlugInDescriptor::isDestroyedAfterExecute | ( | ) | const [pure virtual] |
Queries the value of Executable::isDestroyedAfterExecute() for Executable plug-ins.
- Returns:
- Returns the value provided by Executable::isDestroyedAfterExecute() or true if the plug-in is not of type Executable.
| virtual const std::vector<std::string>& PlugInDescriptor::getMenuLocations | ( | ) | const [pure virtual] |
Queries the value of Executable::getMenuLocations() for Executable plug-ins.
- Returns:
- Returns the value provided by Executable::getMenuLocations() or an empty vector if the plug-in is not of type Executable.
| virtual bool PlugInDescriptor::hasAbort | ( | ) | const [pure virtual] |
Queries the value of Executable::hasAbort() for Executable plug-ins.
- Returns:
- Returns the value provided by Executable::hasAbort() or false if the plug-in is not of type Executable.
| virtual bool PlugInDescriptor::hasBatchSupport | ( | ) | const [pure virtual] |
Queries the value of Executable::setBatch() for Executable plug-ins.
- Returns:
- Returns true if Executable::setBatch() will return true, false otherwise. If the plug-in is not of type Executable, false will be returned.
| virtual bool PlugInDescriptor::hasInteractiveSupport | ( | ) | const [pure virtual] |
Queries the value of Executable::setInteractive() for Executable plug-ins.
- Returns:
- Returns true if Executable::setInteractive() will return true, false otherwise. If the plug-in is not of type Executable, false will be returned.
| virtual bool PlugInDescriptor::hasWizardSupport | ( | ) | const [pure virtual] |
Queries the value of Executable::hasWizardSupport() for Executable plug-ins.
- Returns:
- Returns the value provided by Executable::hasWizardSupport() or false if the plug-in is not of type Executable.
| virtual const PlugInArgList* PlugInDescriptor::getBatchInputArgList | ( | ) | const [pure virtual] |
Returns the batch input argument list for Executable plug-ins.
The returned PlugInArgList is owned by this object, so do not attempt to delete it.
- Returns:
- Returns the PlugInArgList that was returned via the pArgList parameter of Executable::getInputSpecification() after setBatch() was called on the plug-in instance. If the plug-in is not of type Executable, NULL will be returned.
| virtual const PlugInArgList* PlugInDescriptor::getInteractiveInputArgList | ( | ) | const [pure virtual] |
Returns the interactive input argument list for Executable plug-ins.
The returned PlugInArgList is owned by this object, so do not attempt to delete it.
- Returns:
- Returns the PlugInArgList that was returned via the pArgList parameter of Executable::getInputSpecification() after setInteractive() was called on the plug-in instance. If the plug-in is not of type Executable, NULL will be returned.
| virtual const PlugInArgList* PlugInDescriptor::getBatchOutputArgList | ( | ) | const [pure virtual] |
Returns the batch output argument list for Executable plug-ins.
The returned PlugInArgList is owned by this object, so do not attempt to delete it.
- Returns:
- Returns the PlugInArgList that was returned via the pArgList parameter of Executable::getOutputSpecification() after setBatch() was called on the plug-in instance. If the plug-in is not of type Executable, NULL will be returned.
| virtual const PlugInArgList* PlugInDescriptor::getInteractiveOutputArgList | ( | ) | const [pure virtual] |
Returns the interactive output argument list for Executable plug-ins.
The returned PlugInArgList is owned by this object, so do not attempt to delete it.
- Returns:
- Returns the PlugInArgList that was returned via the pArgList parameter of Executable::getOutputSpecification() after setInteractive() was called on the plug-in instance. If the plug-in is not of type Executable, NULL will be returned.
| virtual std::string PlugInDescriptor::getFileExtensions | ( | ) | const [pure virtual] |
Returns the file extensions supported by this plug-in.
If the plug-in is of type Importer, then the returned value will be Importer::getDefaultExtensions(). If the plug-in is of type Exporter, then the returned value will be Exporter::getDefaultExtensions(). If the plug-in is of type Interpreter, then the returned value will be Interpreter::getFileExtensions(). If the plug-in is none of these types, then an empty string will be returned.
- Returns:
- The file extensions supported by this plug-in.
| virtual bool PlugInDescriptor::isTestable | ( | ) | const [pure virtual] |
Queries whether the plug-in is Testable.
- Returns:
- Returns true if the plug-in instance could be successfully cast to a Testable*, false otherwise.