Click or drag to resize

RelaxISPlugin_CircuitElement2 Class

This defines a circuit element with a certain impedance response to be used in equivalent circuits.
Inheritance Hierarchy
SystemObject
  RelaxIS_SDK.PluginsRelaxISPlugin
    RelaxIS_SDK.PluginsRelaxISPlugin_CircuitElement2

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

The RelaxISPlugin_CircuitElement2 type exposes the following members.

Constructors
 NameDescription
Protected methodRelaxISPlugin_CircuitElement2Initializes a new instance of the RelaxISPlugin_CircuitElement2 class
Top
Properties
 NameDescription
Public propertyAbbreviation The abbreviation to use in circuit strings
Public propertyDescription A short description of what the plugin does. Displayed on various occasions for clarification
(Inherited from RelaxISPlugin)
Public propertyFormula The formula, used to calculate the impedance. FOR DISPLAY PURPOSES ONLY!
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)
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 propertyStandardParameters Gets the collection of standard parameters for this circuit element.
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 methodCalculateImpedance The function used to calculate the impedance of the single circuit element.
Public methodCompareTo Compares the plugin to another based on the SortIndex property
(Inherited from RelaxISPlugin)
Public methodGetAdditionalInformation Provides additional information about this tool.
(Overrides RelaxISPluginGetAdditionalInformation)
Public methodGetTightLimits 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.
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
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