PlugInManagerServices Class Reference
[Services]

Provides access to the plug-in argument list and their arguments. More...

#include <PlugInManagerServices.h>

Inheritance diagram for PlugInManagerServices:

Inheritance graph

List of all members.

Public Member Functions

virtual std::vector< PlugIn * > getPlugInInstances (const std::string &plugInName=std::string())=0
virtual PlugIn * createPlugIn (const std::string &plugInName)=0
virtual bool destroyPlugIn (PlugIn *pPlugIn)=0
virtual std::vector
< PlugInDescriptor * > 		getPlugInDescriptors (const std::string &plugInType="") const =0
virtual PlugInDescriptor * getPlugInDescriptor (const std::string &plugInName) const =0
virtual PlugInArgList * getPlugInArgList ()=0
virtual bool destroyPlugInArgList (PlugInArgList *pArgList)=0
virtual const std::vector
< std::string > & 		getArgTypes ()=0
virtual PlugInArg * getPlugInArg ()=0
virtual DynamicModule * getDynamicModule (const std::string &value)=0
virtual bool destroyDynamicModule (DynamicModule *pModule)=0
virtual Progress * getProgress (PlugIn *pPlugIn)=0

Static Public Member Functions

static std::string ImporterType ()
static std::string AlgorithmType ()
static std::string DockWindowType ()
static std::string ExporterType ()
static std::string GeoreferenceType ()
static std::string InterpreterManagerType ()
static std::string PropertiesType ()
static std::string RasterPagerType ()
static std::string ViewerType ()
static std::string WizardType ()
static std::string OptionType ()
static const std::string & signalPlugInCreated ()
static const std::string & signalPlugInDestroyed ()
static const std::string & signalModuleCreated ()
static const std::string & signalModuleDestroyed ()

Protected Member Functions

virtual ~PlugInManagerServices ()

Detailed Description

Provides access to the plug-in argument list and their arguments.

PlugInManagerServices provides methods for creating and destroying PlugInArgs and ArgLists. These arg lists are used for passing arguments to plugins. A plug-in needs to create a new input and output arglist every time its getInputSpecification or getOutputSpecification methods are called. It is the responsibility of the caller of the plug-in to destroy the arg lists when they are done with them.

This subclass of Subject will notify upon the following conditions:

See also:
PlugInArg, PlugInArgList

Definition at line 51 of file PlugInManagerServices.h.

Constructor & Destructor Documentation

virtual PlugInManagerServices::~PlugInManagerServices (  )  [protected, virtual]

This will be cleaned up during application close.

Plug-ins do not need to destroy it.

Definition at line 469 of file PlugInManagerServices.h.

Member Function Documentation

static std::string PlugInManagerServices::ImporterType (  )  [static]

The type that should be returned from PlugIn::getType() for types of plug-in that implement the Importer interface.

Returns:
Returns the type used for importer plug-ins.

Definition at line 60 of file PlugInManagerServices.h.

static std::string PlugInManagerServices::AlgorithmType (  )  [static]

The type that should be returned from PlugIn::getType() for algorithm plug-ins.

Returns:
Returns the type used for algorithm plug-ins.
See also:
AlgorithmShell

Definition at line 73 of file PlugInManagerServices.h.

static std::string PlugInManagerServices::DockWindowType (  )  [static]

The type that should be returned from PlugIn::getType() for dock window plug-ins.

Returns:
Returns the type used for dock window plug-ins.
See also:
DockWindowShell

Definition at line 86 of file PlugInManagerServices.h.

static std::string PlugInManagerServices::ExporterType (  )  [static]

The type that should be returned from PlugIn::getType() for types of plug-in that implement the Exporter interface.

Returns:
Returns the type used for exporter plug-ins.

Definition at line 97 of file PlugInManagerServices.h.

static std::string PlugInManagerServices::GeoreferenceType (  )  [static]

The type that should be returned from PlugIn::getType() for types of plug-in that implement the Georeference interface.

Returns:
Returns the type used for georeference plug-ins.

Definition at line 108 of file PlugInManagerServices.h.

static std::string PlugInManagerServices::InterpreterManagerType (  )  [static]

The type that should be returned from PlugIn::getType() for types of plug-in that implement the InterpreterManager interface.

Returns:
Returns the type used for interpreter plug-ins.

Definition at line 119 of file PlugInManagerServices.h.

static std::string PlugInManagerServices::PropertiesType (  )  [static]

The type that should be returned from PlugIn::getType() for types of plug-ins that implement the Properties interface.

Returns:
Returns the type used for properties plug-ins.
See also:
PropertiesShell

Definition at line 132 of file PlugInManagerServices.h.

static std::string PlugInManagerServices::RasterPagerType (  )  [static]

The type that should be returned from PlugIn::getType() for types of plug-in that implement the RasterPager interface.

Returns:
Returns the type used for raster pager plug-ins.

Definition at line 143 of file PlugInManagerServices.h.

static std::string PlugInManagerServices::ViewerType (  )  [static]

The type that should be returned from PlugIn::getType() for viewer plug-ins.

Returns:
Returns the type used for viewer plug-ins.
See also:
ViewerShell

Definition at line 156 of file PlugInManagerServices.h.

static std::string PlugInManagerServices::WizardType (  )  [static]

The type that should be returned from PlugIn::getType() for wizard plug-ins.

Returns:
Returns the type used for wizard plug-ins.
See also:
WizardShell

Definition at line 169 of file PlugInManagerServices.h.

static std::string PlugInManagerServices::OptionType (  )  [static]

The type that should be returned from PlugIn::getType() for types of plug-ins that implement the Option interface.

Definition at line 178 of file PlugInManagerServices.h.

static const std::string& PlugInManagerServices::signalPlugInCreated (  )  [static]

Emitted with any<PlugIn*> when a new plug-in instance is created.

Definition at line 186 of file PlugInManagerServices.h.

static const std::string& PlugInManagerServices::signalPlugInDestroyed (  )  [static]

Emitted with any<PlugIn*> when a plug-in instance is about to be destroyed.

Definition at line 191 of file PlugInManagerServices.h.

static const std::string& PlugInManagerServices::signalModuleCreated (  )  [static]

Emitted with any<ModuleDescriptor*> when a new module descriptor is created.

Definition at line 196 of file PlugInManagerServices.h.

static const std::string& PlugInManagerServices::signalModuleDestroyed (  )  [static]

Emitted with any<ModuleDescriptor*> when a module descriptor is about to be destroyed.

Definition at line 201 of file PlugInManagerServices.h.

virtual std::vector<PlugIn*> PlugInManagerServices::getPlugInInstances ( const std::string &  plugInName = std::string()  )  [pure virtual]

Get running instances of a plug-in.

This method returns all running instances of a plug-in.

Parameters:
plugInName Get instances of this named plug-in. If this string is empty, it will get all of the running instances of all plug-ins.
Returns:
A vector of PlugIn pointers for running instances of the plug-in.

virtual PlugIn* PlugInManagerServices::createPlugIn ( const std::string &  plugInName  )  [pure virtual]

Creates a new instance of a plug-in.

This method instantiates the plug-in of the given name and returns a reference to the new plug-in.

Parameters:
plugInName The name of the plug-in to create.
Returns:
A pointer to the new plug-in. NULL is returned if the plug-in cannot be created. This may occur if an instance of the plug in already exists and the plug-in does not support multiple instances.
See also:
PlugIn::areMultipleInstancesAllowed()

virtual bool PlugInManagerServices::destroyPlugIn ( PlugIn *  pPlugIn  )  [pure virtual]

Destroys an instance of a plug-in.

Parameters:
pPlugIn The plug-in to destroy.
Returns:
TRUE if the plug-in was successfully destroyed, otherwise FALSE.

virtual std::vector<PlugInDescriptor*> PlugInManagerServices::getPlugInDescriptors ( const std::string &  plugInType = ""  )  const [pure virtual]

Returns a list of all PlugInDescriptors that match the given type as returned by PlugIn::getType().

Parameters:
plugInType The type of plug-ins for which to return descriptors for. If any empty string is provided, descriptors for all available plug-ins will be returned.
Returns:
Returns a list all PlugInDescriptors that match the given type.

virtual PlugInDescriptor* PlugInManagerServices::getPlugInDescriptor ( const std::string &  plugInName  )  const [pure virtual]

Returns the PlugInDescriptor for the given plug-in.

Parameters:
plugInName The plug-in to return the descriptor for.
Returns:
Returns the PlugInDescriptor for the given plug-in or NULL if no plug-in has been registered with the given name.

virtual PlugInArgList* PlugInManagerServices::getPlugInArgList (  )  [pure virtual]

Create an empty plug-in arg list.

Creates an empty plug-in arg list to have PlugInArgs added to it.

Returns:
A pointer to the new list, or NULL if unsuccessful.

virtual bool PlugInManagerServices::destroyPlugInArgList ( PlugInArgList *  pArgList  )  [pure virtual]

Destroys a plug-in arg list.

This method destroys a plug-in arg list, including all of its plug-in args. The args should not be destroyed prior to calling this method.

Parameters:
pArgList A pointer to the arg-list to destroy.
Returns:
TRUE if the list and all of its args were destroyed or FALSE otherwise.

virtual const std::vector<std::string>& PlugInManagerServices::getArgTypes (  )  [pure virtual]

Get the names of the known types.

This method returns the names of each recognized arg type. Plug-ins can retrieve this list to query if a data type is in the known list. The wizard builder uses this list connect plug-in in sequence according to their type names. If an arg type exists that is not in this list, the wizard builder indicates it as an unknown type.

The default known types are as follows:

Returns:
A vector of strings specifying the name of each known arg type.

virtual PlugInArg* PlugInManagerServices::getPlugInArg (  )  [pure virtual]

Creates a plug-in arg.

Creates a blank plug-in arg that can be added to a PlugInArgList.

Returns:
A pointer to the new arg, or NULL if unsuccessful.

virtual DynamicModule* PlugInManagerServices::getDynamicModule ( const std::string &  value  )  [pure virtual]

Creates an empty dynamic module.

Parameters:
value The name of the plug-in.
Returns:
A pointer to the new DynamicModule, or NULL if the module could not be created.
See also:
DynamicModule::load()

virtual bool PlugInManagerServices::destroyDynamicModule ( DynamicModule *  pModule  )  [pure virtual]

Destroys a dynamic module.

Parameters:
pModule A pointer to the dynamic module to destroy.
Returns:
TRUE if the dynamic module was destroyed or FALSE otherwise.

virtual Progress* PlugInManagerServices::getProgress ( PlugIn *  pPlugIn  )  [pure virtual]

Retrieves a non-thread-safe Progress object for a given plug-in.

This method retrieves a valid Progress object for the given plug-in, which remains valid throughout the life of the plug-in. Because the Progress object set into the plug-in's input arg list may be deleted when Executable::execute() returns, this method should be called for plug-ins that will stay loaded after Executable::execute() returns and that need a valid Progress object. This is especially useful for plug-ins that create modeless dialogs.

If a thread-safe Progress object is needed for a background plug-in running in a separate thread, use UtilityServices::getProgress() instead.

Parameters:
pPlugIn The plug-in for which to get a Progress object.
Returns:
A pointer to the Progress object for the given plug-in.
See also:
Executable::isDestroyedAfterExecute()

Software Development Kit - Opticks 4.9.0 Build 16218