openPDC Historian Help
ExporterBase Class
NamespacesTVA.Historian.ExportersExporterBase
Base class for an exporter of real-time time-series data.
Declaration Syntax
C#Visual BasicVisual C++
public abstract class ExporterBase : IExporter, 
	IDisposable
Public MustInherit Class ExporterBase _
	Implements IExporter, IDisposable
public ref class ExporterBase abstract : IExporter, 
	IDisposable
Members
All MembersConstructorsMethodsPropertiesFieldsEvents



IconMemberDescription
ExporterBase(String)
Initializes a new instance of the exporter.

DatasetTemplate(String)
Returns a template DataSet that can be used for storing time-series data in a tabular format.

Dispose()()()
Releases all the resources used by the exporter.

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

Equals(Object)
Determines whether the current exporter object is equal to obj.
(Overrides Object.Equals(Object).)
ExportAddedHandler
Gets or sets the Delegate to be invoked when a new Export is added to the Exports.

ExportProcessed
Occurs when the exporter finishes processing an Export.

ExportProcessException
Occurs when the exporter fails to process an Export due to an Exception.

ExportRemovedHandler
Gets or sets the Delegate to be invoked when an existing Export is removed from the Exports.

Exports
Gets the Exports associated with the exporter.

ExportUpdatedHandler
Gets or sets the Delegate to be invoked when an existing Export from the Exports is updated.

FileLockWaitTime
Number of seconds to wait to obtain a write lock on a file.

Finalize()()()
Releases the unmanaged resources before the exporter is reclaimed by GC.
(Overrides Object.Finalize()()().)
FindExport(String)
Returns the Export for the specified exportName from the Exports.

FindListener(String)
Returns the DataListener for the specified listenerName from the Listeners.

GetExportData(Export)
Returns the current time-series data for the specified export organized by listener.

GetExportDataAsDataset(Export, String)
Returns the current time-series data for the specified export in a DataSet.

GetHashCode()()()
Returns the hash code for the current exporter object.
(Overrides Object.GetHashCode()()().)
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
Listeners
Gets the DataListeners providing real-time time-series data to the exporter.

MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Name
Gets or sets the name of the exporter.

OnExportProcessed(Export)
Raises the ExportProcessed event.

OnExportProcessException(Export, Exception)
Raises the ExportProcessException event.

OnStatusUpdate(String)
Raises the StatusUpdate event.

ProcessExport(Export)
When overridden in a derived class, processes the export using the current Data.

ProcessExport(String)
Processes Export with the specified exportName.

ProcessRealTimeData(Object, EventArgs<(Of <(IList<(Of <(IDataPoint>)>)>)>))
Handles the DataExtracted event for all the Listeners.

ProcessRealTimeExport(Export, DataListener, IList<(Of <(IDataPoint>)>))
When overridden in a derived class, processes the export using the real-time data.

RealTimeExportQueue
Gets the internal ProcessQueue used for processing Exports defined as RealTime.

StatusUpdate
Occurs when the exporter want to provide a status update.

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

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