|
IMetadata
|
Defines a provider of updates to the data in a MetadataFile.
Namespace: GSF.Historian.MetadataProviders
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.258-beta
Syntaxpublic interface IMetadataProvider : IAdapter, ISupportLifecycle, IDisposable, IProvideStatus, IPersistSettings
The IMetadataProvider type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Domain |
Gets the AppDomain in which the IAdapter is executing.
(Inherited from IAdapter) |
| Enabled |
Gets or sets a boolean value that indicates whether the object is enabled.
(Inherited from ISupportLifecycle) |
| HostFile |
Gets or sets the path to the file where the IAdapter is housed.
(Inherited from IAdapter) |
| IsDisposed |
Gets a flag that indicates whether the object has been disposed.
(Inherited from ISupportLifecycle) |
| MemoryUsage |
Gets the memory utilization of the IAdapter in bytes if executing in a separate AppDomain, otherwise NaN.
(Inherited from IAdapter) |
| Metadata | Gets or sets the MetadataFile to be refreshed by the metadata provider. |
| Name |
Gets the name of the object providing status information.
(Inherited from IProvideStatus) |
| PersistSettings |
Determines whether the object settings are to be persisted to the config file.
(Inherited from IPersistSettings) |
| ProcessorUsage |
Gets the % processor utilization of the IAdapter if executing in a separate AppDomain otherwise NaN.
(Inherited from IAdapter) |
| RefreshInterval | Gets or sets the number of minutes at which the Metadata if to be refreshed automatically. |
| RefreshTimeout | Gets or sets the number of seconds to wait for the Refresh to complete. |
| SettingsCategory |
Gets or sets the category name under which the object settings are persisted in the config file.
(Inherited from IPersistSettings) |
| Status |
Gets the current status details about object providing status information.
(Inherited from IProvideStatus) |
| TypeName |
Gets or sets the text representation of the IAdapter's TypeName.
(Inherited from IAdapter) |
Methods| Name | Description | |
|---|---|---|
 | Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable) |
| Initialize |
Initializes the state of the object.
(Inherited from ISupportLifecycle) |
| LoadSettings |
Loads saved settings from the config file.
(Inherited from IPersistSettings) |
| Refresh | Refreshes the Metadata from an external source. |
| SaveSettings |
Saves settings to the config file.
(Inherited from IPersistSettings) |
Events| Name | Description | |
|---|---|---|
 | Disposed |
Raised after the source object has been properly disposed.
(Inherited from ISupportLifecycle) |
| ExecutionException |
Occurs when the IAdapter encounters an Exception during execution.
(Inherited from IAdapter) |
| MetadataRefreshComplete | Occurs when Refresh of Metadata is completed. |
| MetadataRefreshException | Occurs when an Exception is encountered during Refresh of Metadata. |
| MetadataRefreshStart | Occurs when Refresh of Metadata is started. |
| MetadataRefreshTimeout | Occurs when Refresh of Metadata times out. |
| StatusUpdate |
Occurs when the IAdapter wants to provide a status update.
(Inherited from IAdapter) |
See Also