Click or drag to resize

StatisticsExporter Class

Represents an exporter that can export the StatisticsExporter.Statistics in CSV or XML format to a file.
Inheritance Hierarchy
System.Object
  GSF.Historian.Exporters.ExporterBase
    GSF.Historian.Exporters.RawDataExporter
      GSF.Historian.Exporters.StatisticsExporter

Namespace: GSF.Historian.Exporters
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.249-beta
Syntax
public class StatisticsExporter : RawDataExporter
View Source

The StatisticsExporter type exposes the following members.

Constructors
 NameDescription
Public methodStatisticsExporter() Initializes a new instance of the StatisticsExporter class.
Protected methodStatisticsExporter(String) Initializes a new instance of the StatisticsExporter class.
Top
Properties
 NameDescription
Protected propertyExportAddedHandler Gets or sets the Delegate to be invoked when a new Export is added to the Exports.
(Inherited from ExporterBase)
Protected propertyExportRemovedHandler Gets or sets the Delegate to be invoked when an existing Export is removed from the Exports.
(Inherited from ExporterBase)
Public propertyExports Gets the Exports associated with the exporter.
(Inherited from ExporterBase)
Protected propertyExportUpdatedHandler Gets or sets the Delegate to be invoked when an existing Export from the Exports is updated.
(Inherited from ExporterBase)
Public propertyListeners Gets the DataListeners providing real-time time-series data to the exporter.
(Inherited from ExporterBase)
Public propertyName Gets or sets the name of the exporter.
(Inherited from ExporterBase)
Protected propertyRealTimeExportQueue Gets the internal ProcessQueue<T> used for processing Exports defined as RealTime.
(Inherited from ExporterBase)
Top
Methods
 NameDescription
Public methodDispose() Releases all the resources used by the exporter.
(Inherited from ExporterBase)
Protected methodDispose(Boolean) Releases the unmanaged resources used by the exporter and optionally releases the managed resources.
(Inherited from ExporterBase)
Public methodEquals Determines whether the current exporter object is equal to obj.
(Inherited from ExporterBase)
Protected methodFinalize Releases the unmanaged resources before the exporter is reclaimed by GC.
(Inherited from ExporterBase)
Public methodFindExport Returns the Export for the specified exportName from the Exports.
(Inherited from ExporterBase)
Public methodFindListener Returns the DataListener for the specified listenerName from the Listeners.
(Inherited from ExporterBase)
Protected methodGetBufferedData Returns a DataSet containing the buffered real-time time-series data.
(Inherited from RawDataExporter)
Protected methodGetExportData Returns the current time-series data for the specified export organized by listener.
(Inherited from ExporterBase)
Protected methodGetExportDataAsDataset Returns the current time-series data for the specified export in a DataSet.
(Inherited from ExporterBase)
Public methodGetHashCode Returns the hash code for the current exporter object.
(Inherited from ExporterBase)
Protected methodGetStatistics Returns the calculated StatisticsExporter.Statistics from buffered data of the specified export.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnExportProcessed Raises the ExportProcessed event.
(Inherited from ExporterBase)
Protected methodOnExportProcessException Raises the ExportProcessException event.
(Inherited from ExporterBase)
Protected methodOnStatusUpdate Raises the StatusUpdate event.
(Inherited from ExporterBase)
Protected methodProcessExport(Export) Processes the export using the current Data.
(Overrides RawDataExporter.ProcessExport(Export))
Public methodProcessExport(String) Processes Export with the specified exportName.
(Inherited from ExporterBase)
Protected methodProcessRealTimeData Handles the DataExtracted event for all the Listeners.
(Inherited from RawDataExporter)
Protected methodProcessRealTimeExport Processes the export using the real-time data.
(Overrides RawDataExporter.ProcessRealTimeExport(Export, DataListener, IList<IDataPoint>))
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventExportProcessed Occurs when the exporter finishes processing an Export.
(Inherited from ExporterBase)
Public eventExportProcessException Occurs when the exporter fails to process an Export due to an Exception.
(Inherited from ExporterBase)
Public eventStatusUpdate Occurs when the exporter want to provide a status update.
(Inherited from ExporterBase)
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefault<T> 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 StatisticsExporter:
C#
<?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>StatisticsExporte</Name>
  <Type>Intervaled</Type>
  <Interval>10</Interval>
  <Exporter>StatisticsExporter</Exporter>
  <Settings>
    <ExportSetting>
      <Name>OutputFile</Name>
      <Value>\\trotibco\XML\EIRA.xml</Value>
    </ExportSetting>
    <ExportSetting>
      <Name>OutputFormat</Name>
      <Value>XML</Value>
    </ExportSetting>    
    <ExportSetting>
      <Name>FilterClause</Name>
      <Value>Value&gt;=59 And Value&lt;=61</Value>
    </ExportSetting>
    <ExportSetting>
      <Name>SlopeThreshold</Name>
      <Value>.9</Value>
    </ExportSetting>
  </Settings>
  <Records>
    <ExportRecord>
      <Instance>P1</Instance>
      <Identifier>1285</Identifier>
    </ExportRecord>    
    <ExportRecord>
      <Instance>P2</Instance>
      <Identifier>3173</Identifier>
    </ExportRecord>    
    <ExportRecord>
      <Instance>P3</Instance>
      <Identifier>1838</Identifier>
    </ExportRecord>    
 </Records>
</Export>

Description of custom settings required by StatisticsExporter in an Export:
Setting NameSetting Description
OutputFileName of the CSV or XML file (including path) where export data is to be written.
OutputFormatFormat (CSV or XML) in which export data is to be written to the output file.
FilterClause (Optional)SQL-like expression to be used for limiting the data included in the calculation.
SlopeThreshold (Optional)Floating point value to be used for eliminating data with a slope exceeding the specified threshold.

See Also