RelaxISPlugin_TransferFunction Class

This defines a transfer function by recalculating an impedance value using frequency, Z' and Z''.

Inheritance Hierarchy

SystemObject
RelaxIS_SDK.PluginsRelaxISPlugin
RelaxIS_SDK.PluginsRelaxISPlugin_TransferFunction

Namespace: RelaxIS_SDK.Plugins
Assembly: RelaxIS SDK (in RelaxIS SDK.dll) Version: 3.0.23.63

Syntax

public abstract class RelaxISPlugin_TransferFunction : RelaxISPlugin

Public MustInherit Class RelaxISPlugin_TransferFunction
	Inherits RelaxISPlugin

Dim instance As RelaxISPlugin_TransferFunction

The RelaxISPlugin_TransferFunction type exposes the following members.

Constructors

	Name	Description
	RelaxISPlugin_TransferFunction	Initializes a new instance of the RelaxISPlugin_TransferFunction class

Properties

	Name	Description
	CanBeNormalized	Indicates, if the transfer function supports being normalized
	Description	A short description of what the plugin does. Displayed on various occasions for clarification (Inherited from RelaxISPlugin)
	IsImaginaryUsuallyNegative	Defines if the imaginary part of the values produced is in most cases negative. Is used in conjunction with premade plots to define which values to display exactly.
	Name	The plugins's internal name, that is used to reference it on various occasions (Inherited from RelaxISPlugin)
	NormalizedSymbol	The symbol of the normalized value
	NormalizedUnit	The unit of the normalized value
	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)
	SuitableForEpsOnlyData	If set to true it signals, that the normalized value is calculated correctly from Eps'/Eps'' values, when an Area of 1/Eps0 and a Thickness of 1 is assumed
	Symbol	The converters symbol for display purposes
	Unit	The converters unit for display purposes
	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)
	CompareTo	Compares the plugin to another based on the SortIndex property (Inherited from RelaxISPlugin)
	ConvertData(Double)	Internal method to quickly convert a whole array of impedance values.
	ConvertData(IEnumerableEISDatapoint)	Convert the full list of EIS datapoints.
	ConvertData(IEnumerableEISValue)	Convert the full list of EIS values.
	ConvertValue	Convert a complex impedance value into the respective other transfer function value.
	GetAdditionalInformation	Provides additional information about this tool. (Overrides RelaxISPluginGetAdditionalInformation)
	NormalizeValue	Overriding this function allows calculation of a normalized value for the transfer function, e.g. conductivity from admittance. This is mainly used in the Combined Data Plot feature.
	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)