Click or drag to resize

RelaxISPlugin_Wizard Class

The basic class for a wizard.
Inheritance Hierarchy
SystemObject
  RelaxIS_SDK.PluginsRelaxISPlugin
    RelaxIS_SDK.PluginsRelaxISOnlyPlugin
      RelaxIS_SDK.PluginsRelaxISPlugin_Wizard

Namespace: RelaxIS_SDK.Plugins
Assembly: RelaxIS SDK (in RelaxIS SDK.dll) Version: 3.0.23.63
Syntax
Copy
public abstract class RelaxISPlugin_Wizard : RelaxISOnlyPlugin

The RelaxISPlugin_Wizard type exposes the following members.

Constructors
 NameDescription
Protected methodRelaxISPlugin_WizardInitializes a new instance of the RelaxISPlugin_Wizard class
Top
Properties
 NameDescription
Public propertyDescription A short description of what the plugin does. Displayed on various occasions for clarification
(Inherited from RelaxISPlugin)
Public propertyDescriptionImage An image that is displayed alongside the wizard in the wizard dialog
Public propertyIsInteractive Defines if the wizard can be used without previous setup through the wizard dialog. If no user input is required, set this to true to be able to use the wizard e.g. for RelaxIS Remote.
Public propertyName The plugins's internal name, that is used to reference it on various occasions
(Inherited from RelaxISPlugin)
Public propertyPluginSourcePath Gets or sets the full path of the file that the plugin was loaded from.
(Inherited from RelaxISPlugin)
Protected propertyRelaxISProgramInterface Gets an instance of the RelaxIS Program interface for the RelaxIS instance that the plugin is loaded in.
(Inherited from RelaxISOnlyPlugin)
Protected propertyRelaxISWCFInterface Gets an instance of the WCF interface for the RelaxIS instance that the plugin is loaded in.
(Inherited from RelaxISOnlyPlugin)
Public propertySortIndex By default the plugins are sorted based on the value of this property. That means, that they appear in lists in the order dictated by this value.
(Inherited from RelaxISPlugin)
Public propertyTitle The title of the wizard that is displayed in the wizard dialog
Public propertyUserDataDirectory Gets or sets the path to the RelaxIS user data directory.
(Inherited from RelaxISPlugin)
Top
Methods
 NameDescription
Protected methodAddLogMessage(Exception) Advises RelaxIS to add information about the given exception to the log. Will not work in the object's constructor.
(Inherited from RelaxISPlugin)
Protected methodAddLogMessage(String) Advises RelaxIS to add a new message to the log. Will not work in the object's constructor.
(Inherited from RelaxISPlugin)
Public methodAfterStartupInitialization Is called once after the plugin is initialized with all internal information during program start.
(Inherited from RelaxISPlugin)
Public methodCompareTo Compares the plugin to another based on the SortIndex property
(Inherited from RelaxISPlugin)
Public methodGetAdditionalInformation Provides additional information about this plugin, like e.g. the unit of a transfer function.
(Inherited from RelaxISPlugin)
Public methodGetFurtherEvaluation Called after the fitting is completed and is used to further evaluate the fitting results, for example to calculate further results (e.g. conductivity from a resistance)
Public methodGetOptions Get a list of wizard options to be set by the user, that are displayed in the wizard dialog before the RetrieveFitSetup method is called
Public methodInternalSetProgramInstance Set the internal program instance to a new value.
(Inherited from RelaxISOnlyPlugin)
Public methodInternalSetWCFInstance Set the internal wcf instance to a new value.
(Inherited from RelaxISOnlyPlugin)
Public methodRetrieveFitSetup Called after the user selected the options and should retrieve correct fitting initial values from the InputSpectrum
Public methodShouldDiscardPlugin Called once after the plugin is initialized and after AfterStartupInitialization and signals to RelaxIS if the plugin should be used or discarded.
(Inherited from RelaxISPlugin)
Top
Remarks
0. The spectrum to work with is supplied by the "InputSpectrum" parameter 1. RelaxIS creates a 'Settings' page from the options returned by "GetOptions" 2. The user edits the values and RelaxIS sets the "OptionValues" dictionary with the results 3. "RetrieveFitSetup" is called to calculate starting parameters for the fit and further options 4. RelaxIS performs the fit with the values returned by "RetrieveFitSetup" 5. "GetFurtherEvaluation" is called, with the fit results to allow for further calculations
See Also