Relax |
This class is kept for backwards compatibility. Please use RelaxISPlugin_CircuitElement2 for new developments.
This defines a circuit element with a certain impedance response to be used in equivalent circuits.
Inheritance HierarchyNamespace: RelaxIS_SDK.Plugins
Assembly: RelaxIS SDK (in RelaxIS SDK.dll) Version: 3.0.24.6
SyntaxThe RelaxISPlugin_CircuitElement type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RelaxISPlugin_CircuitElement | Initializes a new instance of the RelaxISPlugin_CircuitElement class |
Properties| Name | Description | |
|---|---|---|
 | Abbreviation | The abbreviation to use in circuit strings |
| Description |
A short description of what the plugin does. Displayed on various occasions for clarification
(Inherited from RelaxISPlugin) |
| Formula | The formula, used to calculate the impedance. FOR DISPLAY PURPOSES ONLY! |
| Name |
The plugins's internal name, that is used to reference it on various occasions
(Inherited from RelaxISPlugin) |
| PluginSourcePath |
Gets or sets the full path of the file that the plugin was loaded from.
(Inherited from RelaxISPlugin) |
| SortIndex |
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) |
| StandardParameterFixedStates | A list of default fixed states of the parameters |
| StandardParameterLowerLimits | A list of default parameter lower limits |
| StandardParameterNames | A list of parameter names that are used in parameter list. |
| StandardParameterUpperLimits | A list of default parameter upper limits |
| StandardParameterValues | A list of default parameter values that are used to initialize the element. |
| UserDataDirectory |
Gets or sets the path to the RelaxIS user data directory.
(Inherited from RelaxISPlugin) |
Methods| Name | Description | |
|---|---|---|
| AddLogMessage(Exception) |
Advises RelaxIS to add information about the given exception to the log. Will not work in the object's constructor.
(Inherited from RelaxISPlugin) |
| AddLogMessage(String) |
Advises RelaxIS to add a new message to the log. Will not work in the object's constructor.
(Inherited from RelaxISPlugin) |
 | AfterStartupInitialization |
Is called once after the plugin is initialized with all internal information during program start.
(Inherited from RelaxISPlugin) |
| CalculateImpedance | The function used to calculate the impedance of the single circuit element |
| CompareTo |
Compares the plugin to another based on the SortIndex property
(Inherited from RelaxISPlugin) |
| GetAdditionalInformation |
Provides additional information about this tool.
(Overrides RelaxISPluginGetAdditionalInformation) |
| GetTightLimits | This function by default returns the same limits as the Upper- and LowerLimits property. It can be overridden to allow the calculation of tighter limits for a specific spectrum. |
| ShouldDiscardPlugin |
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) |
Remarks
CAUTION!
The plugin is identified in a fit model only by its Abbreviation property.
A RelaxIS Project (.eis3) file contains fits in the form of the model string and parameters.
That means, if you don't have all the correct plugins, you won't be able to open an .eis3 file that uses it.
This also applies if you have a plugin with the correct abbreviation but a different number of parameters.
Furthermore, if you have a plugin with the same Abbreviation and parameter number but a different mathematical expression
the displayed fit curves and new fits won't match the existing information!
It is also important to only have unique abbreviations, so make sure to not reuse an existing abbreviation.
See Also