Click or drag to resize

RelaxISPlugin_DataManipulation2 Class

This plugin type allows the direct manipulation of every aspect of the spectrum, including the data values, the fit parameters, metadata and so on. The plugin is usually accessed using a ribbon button, defined in the ButtonInformation property. RelaxIS will call the ManipulateSpectraAsync(IListImpedanceSpectrum, ExecutionMode, IWin32Window, CancellationToken) function with the spectra that the user selected. Once the function returns RelaxIS will apply the changed list back to RelaxIS, deleting spectra that longer exists, adding new spectra and changing the data of existing ones. The identification of input and output spectra is based on the GUID property. The plugin may also be used in other functions. Use the ExecutionMode value to determine if the plugin is called from the UI or a standalone version. For standalone execution, no user interaction should be required to complete the ManipulateSpectraAsync(IListImpedanceSpectrum, ExecutionMode, IWin32Window, CancellationToken) function.
Inheritance Hierarchy
SystemObject
  RelaxIS_SDK.PluginsRelaxISPlugin
    RelaxIS_SDK.PluginsRelaxISOnlyPlugin
      RelaxIS_SDK.PluginsRelaxISPlugin_DataManipulation2

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

The RelaxISPlugin_DataManipulation2 type exposes the following members.

Constructors
 NameDescription
Public methodRelaxISPlugin_DataManipulation2 Initializes a new instance of the RelaxISPlugin_DataManipulation2 class.
Top
Properties
 NameDescription
Public propertyButtonInformation Gets the information about the button that will be created to allow the user to call the ManipulateSpectraAsync(IListImpedanceSpectrum, ExecutionMode, IWin32Window, CancellationToken) function.
Public propertyDescription A short description of what the plugin does. Displayed on various occasions for clarification
(Inherited from RelaxISPlugin)
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 propertySpectraSelectionMethod Gets the method used to select spectra for the plugin.
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 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 methodManipulateSpectraAsync Called when the plugin should perform its manipulations.
Protected methodOnPluginProgress Raises the PluginProgress event.
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
Events
Remarks
This is a replacement for the RelaxISPlugin_DataManipulation plugins, providing a more streamlined interface.
See Also