RollingHistoryExporter Class

Represents an exporter that can export current and runtime historic time-series data in CSV or XML format to a file.

Inheritance Hierarchy

SystemObject
GSF.Historian.ExportersExporterBase
GSF.Historian.ExportersRollingHistoryExporter

Namespace: GSF.Historian.Exporters
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.181-beta

Syntax

C++

JavaScript

Copy

public class RollingHistoryExporter : ExporterBase

Public Class RollingHistoryExporter
	Inherits ExporterBase

public ref class RollingHistoryExporter : public ExporterBase

type RollingHistoryExporter = 
    class
        inherit ExporterBase
    end

GSF.Historian.Exporters.RollingHistoryExporter = function();

Type.createClass(
	'GSF.Historian.Exporters.RollingHistoryExporter',
	GSF.Historian.Exporters.ExporterBase);

View Source

The RollingHistoryExporter type exposes the following members.

Constructors

	Name	Description
	RollingHistoryExporter	Initializes a new instance of the RollingHistoryExporter class.
	RollingHistoryExporter(String)	Initializes a new instance of the RollingHistoryExporter class.

Top

Properties

	Name	Description
	ExportAddedHandler	Gets or sets the Delegate to be invoked when a new Export is added to the Exports. (Inherited from ExporterBase)
	ExportRemovedHandler	Gets or sets the Delegate to be invoked when an existing Export is removed from the Exports. (Inherited from ExporterBase)
	Exports	Gets the Exports associated with the exporter. (Inherited from ExporterBase)
	ExportUpdatedHandler	Gets or sets the Delegate to be invoked when an existing Export from the Exports is updated. (Inherited from ExporterBase)
	Listeners	Gets the DataListeners providing real-time time-series data to the exporter. (Inherited from ExporterBase)
	Name	Gets or sets the name of the exporter. (Inherited from ExporterBase)
	RealTimeExportQueue	Gets the internal ProcessQueueT used for processing Exports defined as RealTime. (Inherited from ExporterBase)

Top

Methods

	Name	Description
	Dispose	Releases all the resources used by the exporter. (Inherited from ExporterBase)
	Dispose(Boolean)	Releases the unmanaged resources used by the exporter and optionally releases the managed resources. (Inherited from ExporterBase)
	Equals	Determines whether the current exporter object is equal to obj. (Inherited from ExporterBase)
	Finalize	Releases the unmanaged resources before the exporter is reclaimed by GC. (Inherited from ExporterBase)
	FindExport	Returns the Export for the specified exportName from the Exports. (Inherited from ExporterBase)
	FindListener	Returns the DataListener for the specified listenerName from the Listeners. (Inherited from ExporterBase)
	GetExportData	Returns the current time-series data for the specified export organized by listener. (Inherited from ExporterBase)
	GetExportDataAsDataset	Returns the current time-series data for the specified export in a DataSet. (Inherited from ExporterBase)
	GetHashCode	Returns the hash code for the current exporter object. (Inherited from ExporterBase)
	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. (Inherited from ExporterBase)
	OnExportProcessException	Raises the ExportProcessException event. (Inherited from ExporterBase)
	OnStatusUpdate	Raises the StatusUpdate event. (Inherited from ExporterBase)
	ProcessExport(Export)	Processes the export using the current Data. (Overrides ExporterBaseProcessExport(Export))
	ProcessExport(String)	Processes Export with the specified exportName. (Inherited from ExporterBase)
	ProcessRealTimeData	Handles the DataExtracted event for all the Listeners. (Inherited from ExporterBase)
	ProcessRealTimeExport	Processes the export using the real-time data. (Overrides ExporterBaseProcessRealTimeExport(Export, DataListener, IListIDataPoint))
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Events

	Name	Description
	ExportProcessed	Occurs when the exporter finishes processing an Export. (Inherited from ExporterBase)
	ExportProcessException	Occurs when the exporter fails to process an Export due to an Exception. (Inherited from ExporterBase)
	StatusUpdate	Occurs when the exporter want to provide a status update. (Inherited from ExporterBase)

Top

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)

Top

Example

Definition of a sample Export that can be processed by RollingHistoryExporter:

Copy

<?xml version="1.0" encoding="utf-16"?>
<Export xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Name>RollingHistoryExport</Name>
  <Type>Intervaled</Type>
  <Interval>60</Interval>
  <Exporter>RollingHistoryExporter</Exporter>
  <Settings>
    <ExportSetting>
      <Name>OutputFile</Name>
      <Value>c:\RollingHistoryExportOutput.xml</Value>
    </ExportSetting>
    <ExportSetting>
      <Name>OutputFormat</Name>
      <Value>XML</Value>
    </ExportSetting>    
    <ExportSetting>
      <Name>OutputTimespan</Name>
      <Value>360</Value>
    </ExportSetting>        
  </Settings>
  <Records>
    <ExportRecord>
      <Instance>TP</Instance>
      <Identifier>25609</Identifier>
    </ExportRecord>
    <ExportRecord>
      <Instance>TP</Instance>
      <Identifier>41517</Identifier>
    </ExportRecord>
 </Records>
</Export>

Description of custom settings required by RollingHistoryExporter in an Export:
Setting Name Setting Description
OutputFile Name of the CSV or XML file (including path) where export data is to be written.
OutputFormat Format (CSV or XML) in which export data is to be written to the output file.
OutputTimespan Span (represented in seconds) of the moving window for which the runtime historic data is to be exported.

Setting Name	Setting Description
OutputFile	Name of the CSV or XML file (including path) where export data is to be written.
OutputFormat	Format (CSV or XML) in which export data is to be written to the output file.
OutputTimespan	Span (represented in seconds) of the moving window for which the runtime historic data is to be exported.

Reference

GSF.Historian.Exporters Namespace

Export