|
Exporter
|
Base class for an exporter of real-time time-series data.
Inheritance Hierarchy
Namespace: GSF.Historian.Exporters
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.257-beta
SyntaxThe ExporterBase type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ExporterBase | Initializes a new instance of the exporter. |
Properties| Name | Description | |
|---|---|---|
 | ExportAddedHandler | Gets or sets the Delegate to be invoked when a new Export is added to the Exports. |
| 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. |
| Listeners | Gets the DataListeners providing real-time time-series data to the exporter. |
| Name | Gets or sets the name of the exporter. |
| RealTimeExportQueue | Gets the internal ProcessQueueT used for processing Exports defined as RealTime. |
Methods| Name | Description | |
|---|---|---|
  | DatasetTemplate | 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 |
Determines whether the current exporter object is equal to obj.
(Overrides ObjectEquals(Object)) |
| Finalize |
Releases the unmanaged resources before the exporter is reclaimed by GC.
(Overrides ObjectFinalize) |
| FindExport | Returns the Export for the specified exportName from the Exports. |
| FindListener | Returns the DataListener for the specified listenerName from the Listeners. |
| GetExportData | Returns the current time-series data for the specified export organized by listener. |
| GetExportDataAsDataset | Returns the current time-series data for the specified export in a DataSet. |
| GetHashCode |
Returns the hash code for the current exporter object.
(Overrides ObjectGetHashCode) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnExportProcessed | Raises the ExportProcessed event. |
| OnExportProcessException | Raises the ExportProcessException event. |
| OnStatusUpdate | 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 | Handles the DataExtracted event for all the Listeners. |
| ProcessRealTimeExport | When overridden in a derived class, processes the export using the real-time data. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events| Name | Description | |
|---|---|---|
 | ExportProcessed | Occurs when the exporter finishes processing an Export. |
| ExportProcessException | Occurs when the exporter fails to process an Export due to an Exception. |
| StatusUpdate | Occurs when the exporter want to provide a status update. |
Fields| Name | Description | |
|---|---|---|
 | FileLockWaitTime | Number of seconds to wait to obtain a write lock on a file. |
Extension Methods| Name | Description | |
|---|---|---|
 | GetEnumValueOrDefault |
Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
| GetEnumValueOrDefaultT |
Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions) |
See AlsoInheritance HierarchySystemObject
GSF.Historian.ExportersExporterBase
GSF.Historian.ExportersCsvExporter
GSF.Historian.ExportersRawDataExporter
GSF.Historian.ExportersRebroadcastExporter
GSF.Historian.ExportersRollingHistoryExporter
GSF.Historian.ExportersXmlExporter
GSF.Historian.ExportersExporterBase
GSF.Historian.ExportersCsvExporter
GSF.Historian.ExportersRawDataExporter
GSF.Historian.ExportersRebroadcastExporter
GSF.Historian.ExportersRollingHistoryExporter
GSF.Historian.ExportersXmlExporter