RollingHistoryExporter Class

Declaration Syntax

C#

Visual Basic

Visual C++

public class RollingHistoryExporter : ExporterBase

Public Class RollingHistoryExporter _
	Inherits ExporterBase

public ref class RollingHistoryExporter : public ExporterBase

Members

Icon	Member	Description
	RollingHistoryExporter()()()	Initializes a new instance of the RollingHistoryExporter class.
	RollingHistoryExporter(String)	Initializes a new instance of the RollingHistoryExporter class.
	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(Object)	Determines whether the current exporter object is equal to obj. (Inherited from ExporterBase.)
	ExportAddedHandler	Gets or sets the Delegate to be invoked when a new Export is added to the Exports. (Inherited from ExporterBase.)
	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.)
	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.)
	Finalize()()()	Releases the unmanaged resources before the exporter is reclaimed by GC. (Inherited from ExporterBase.)
	FindExport(String)	Returns the Export for the specified exportName from the Exports. (Inherited from ExporterBase.)
	FindListener(String)	Returns the DataListener for the specified listenerName from the Listeners. (Inherited from ExporterBase.)
	GetExportData(Export)	Returns the current time-series data for the specified export organized by listener. (Inherited from ExporterBase.)
	GetExportDataAsDataset(Export, String)	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.)
	Listeners	Gets the DataListeners providing real-time time-series data to the exporter. (Inherited from ExporterBase.)
	MemberwiseClone()()()	Creates a shallow copy of the current Object. (Inherited from Object.)
	Name	Gets or sets the name of the exporter. (Inherited from ExporterBase.)
	OnExportProcessed(Export)	Raises the ExportProcessed event. (Inherited from ExporterBase.)
	OnExportProcessException(Export, Exception)	Raises the ExportProcessException event. (Inherited from ExporterBase.)
	OnStatusUpdate(String)	Raises the StatusUpdate event. (Inherited from ExporterBase.)
	ProcessExport(Export)	Processes the export using the current Data. (Overrides ExporterBase.ProcessExport(Export).)
	ProcessExport(String)	Processes Export with the specified exportName. (Inherited from ExporterBase.)
	ProcessRealTimeData(Object, EventArgs<(Of <(IList<(Of <(IDataPoint>)>)>)>))	Handles the DataExtracted event for all the Listeners. (Inherited from ExporterBase.)
	ProcessRealTimeExport(Export, DataListener, IList<(Of <(IDataPoint>)>))	Processes the export using the real-time data. (Overrides ExporterBase.ProcessRealTimeExport(Export, DataListener, IList<(Of <(IDataPoint>)>)).)
	RealTimeExportQueue	Gets the internal ProcessQueue used for processing Exports defined as RealTime. (Inherited from ExporterBase.)
	StatusUpdate	Occurs when the exporter want to provide a status update. (Inherited from ExporterBase.)
	ToString()()()	Returns a String that represents the current Object. (Inherited from Object.)

Examples

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

CopyC#

<?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.

Inheritance Hierarchy

Object
	ExporterBase
		RollingHistoryExporter

All Members	Constructors	Methods	Properties	Events
Public Protected		Instance Static		Declared Inherited