openPDC Historian Help
MetadataProviderBase Class
NamespacesTVA.Historian.MetadataProvidersMetadataProviderBase
Base class for a provider of updates to the data in a MetadataFile.
Declaration Syntax
C#Visual BasicVisual C++
public abstract class MetadataProviderBase : IMetadataProvider, 
	ISupportLifecycle, IDisposable, IPersistSettings
Public MustInherit Class MetadataProviderBase _
	Implements IMetadataProvider, ISupportLifecycle, IDisposable, IPersistSettings
public ref class MetadataProviderBase abstract : IMetadataProvider, 
	ISupportLifecycle, IDisposable, IPersistSettings
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
MetadataProviderBase()()()
Initializes a new instance of the metadata provider.

Dispose()()()
Releases all the resources used by the metadata provider.

Dispose(Boolean)
Releases the unmanaged resources used by the metadata provider and optionally releases the managed resources.

Enabled
Gets or sets a boolean value that indicates whether the metadata provider is currently enabled.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()
Releases the unmanaged resources before the metadata provider is reclaimed by GC.
(Overrides Object.Finalize()()().)
GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
Initialize()()()
Initializes the metadata provider.

LoadSettings()()()
Loads saved metadata provider settings from the config file if the PersistSettings property is set to true.

MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Metadata
Gets or sets the MetadataFile to be refreshed by the metadata provider.

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.

OnMetadataRefreshComplete()()()
Raises the MetadataRefreshComplete event.

OnMetadataRefreshException(Exception)
Raises the MetadataRefreshException event.

OnMetadataRefreshStart()()()
Raises the MetadataRefreshStart event.

OnMetadataRefreshTimeout()()()
Raises the MetadataRefreshTimeout event.

PersistSettings
Gets or sets a boolean value that indicates whether the metadata provider settings are to be saved to the config file.

Refresh()()()
Refreshes the Metadata from an external source.

RefreshInterval
Gets or sets the interval in minutes at which the Metadata if to be refreshed automatically.

RefreshMetadata()()()
When overridden in a derived class, refreshes the Metadata from an external source.

RefreshTimeout
Gets or sets the number of seconds to wait for the Refresh()()() to complete.

SaveSettings()()()
Saves metadata provider settings to the config file if the PersistSettings property is set to true.

SettingsCategory
Gets or sets the category under which the metadata provider settings are to be saved to the config file if the PersistSettings property is set to true.

ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Inheritance Hierarchy

Assembly: TVA.Historian (Module: TVA.Historian) Version: 1.0.33.39252