Relax |
This defines file formats that can be read by RelaxIS directly, without the
need to use the column designation dialog. This also allows the use of binary files without
a column text structure.
Inheritance HierarchySystemObject
RelaxIS_SDK.PluginsRelaxISPlugin
RelaxIS_SDK.PluginsRelaxISOnlyPlugin
RelaxIS_SDK.PluginsRelaxISPlugin_FileFormat
RelaxIS_SDK.PluginsRelaxISPlugin
RelaxIS_SDK.PluginsRelaxISOnlyPlugin
RelaxIS_SDK.PluginsRelaxISPlugin_FileFormat
Namespace: RelaxIS_SDK.Plugins
Assembly: RelaxIS SDK (in RelaxIS SDK.dll) Version: 3.0.23.63
SyntaxThe RelaxISPlugin_FileFormat type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RelaxISPlugin_FileFormat | Initializes a new instance of the RelaxISPlugin_FileFormat class |
Properties| Name | Description | |
|---|---|---|
 | Description |
A short description of what the plugin does. Displayed on various occasions for clarification
(Inherited from RelaxISPlugin) |
| 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) |
 | RelaxISProgramInterface |
Gets an instance of the RelaxIS Program interface for the RelaxIS instance that the plugin is loaded in.
(Inherited from RelaxISOnlyPlugin) |
| RelaxISWCFInterface |
Gets an instance of the WCF interface for the RelaxIS instance that the plugin is loaded in.
(Inherited from RelaxISOnlyPlugin) |
| 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) |
| SourcePath | If the input data comes from a file, this property will contain the full path of the source file |
| 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) |
| GetData(Byte) | Internal overload to read data from a byte array |
| GetData(Stream) | Returns the data in the file in the form of impedance spectra |
| GetData(String, Boolean) | Internal overload to read data from a file or from a string. |
| IdentifyFile(Byte) | Internal overload to handle identification of a byte array |
| IdentifyFile(Stream) | Determine if a file is of the respective datafile by analyzing its contents |
| IdentifyFile(String, Boolean) | Internal overload to handle identification of a file or of a string. |
| InternalSetProgramInstance |
Set the internal program instance to a new value.
(Inherited from RelaxISOnlyPlugin) |
| InternalSetWCFInstance |
Set the internal wcf instance to a new value.
(Inherited from RelaxISOnlyPlugin) |
| 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) |
RemarksYou need to implement a file identification method that checks wether or not the
given data has the correct file format. You then need to implement the GetData function that reads
the data and metadata from the file. You can choose to split the data into spectra yourself and populate
the Spectra list with the results, or let RelaxIS handle this automatically.
For this, populate the RawData list with EIS data and metadata. This list will
then be automatically split by frequency by RelaxIS.
It should be preferred to manually split the spectra if possible to avoid errors.
See Also