Relax |
An axis value is a specific real value that can be calculated from an impedance
derived complex value such as the real part of the value or the phase angle
Inheritance HierarchyNamespace: RelaxIS_SDK.Plugins
Assembly: RelaxIS SDK (in RelaxIS SDK.dll) Version: 3.0.24.6
SyntaxThe RelaxISPlugin_AxisValue type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RelaxISPlugin_AxisValue | Initializes a new instance of the RelaxISPlugin_AxisValue class |
Properties| Name | Description | |
|---|---|---|
 | Description |
A short description of what the plugin does. Displayed on various occasions for clarification
(Inherited from RelaxISPlugin) |
| IsLogarithmicByDefault | Defines if the Logarithmic Scaling option is selected by default for this axis value or if no preference can be set |
| 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) |
| 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) |
| GetAdditionalInformation |
Provides additional information about this plugin, like e.g. the unit of a transfer function.
(Inherited from RelaxISPlugin) |
| GetValue | Should calculate and return the real value from the supplied impedance and converter. |
| GetValues(Double, RelaxISPlugin_TransferFunction) | Transforms a whole range of values at once. |
| GetValues(IEnumerableEISDatapoint, RelaxISPlugin_TransferFunction) | Converts the full list of data. |
| GetValues(IEnumerableEISValue, RelaxISPlugin_TransferFunction) | Converts the full list of data. |
| Representation | A (usually) short name that represents the value calculated by this tool for a given converter. |
| 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) |
| Unit | The unit of the value to be displayed on a graphs axis for the given converter. |
Fields| Name | Description | |
|---|---|---|
  | EmptyValueName | The name of the value that represents no selected value |
See Also