WizardShell Class Reference
[Plug-In Shells]

Wizard Shell. More...

#include <WizardShell.h>

Inheritance diagram for WizardShell:

Inheritance graph

List of all members.

Public Member Functions

 WizardShell ()
 ~WizardShell ()
bool getOutputSpecification (PlugInArgList *&pArgList)


Detailed Description

Wizard Shell.

This class represents the shell for a wizard plug-in. Wizard developers would take this class and extend it to support their wizard specific code.

See also:
ExecutableShell

Definition at line 25 of file WizardShell.h.


Constructor & Destructor Documentation

WizardShell::WizardShell (  ) 

Creates a wizard plug-in.

The constructor sets the plug-in type to PlugInManagerServices::WizardType().

See also:
getType()

WizardShell::~WizardShell (  ) 

Destroys the wizard plug-in.


Member Function Documentation

bool WizardShell::getOutputSpecification ( PlugInArgList *&  pArgList  )  [virtual]

Retrieves the plug-in output parameters.

This method queries the plug-in for its output parameters that are created during execution. The output arguments may be different in interactive mode and batch mode.

Parameters:
pArgList A plug-in arg list pointer that is set to a created output argument list specifying the plug-in output parameters. NULL is a valid pointer value if the plug-in does not provide any output arguments.
Returns:
Returns true if the output parameter argument list was successfully created. If the plug-in does not provide output arguments, true is returned, but the given plug-in arg list pointer may be NULL.
See also:
PlugInArgList

Default Implementation:
The default implementation does not set any args in the arg list and returns true.

Implements Executable.


Software Development Kit - Opticks 4.9.0 Build 16218