Represents an exporter that can export the current time-series data in CSV format to a file.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class CsvExporter : ExporterBase
Public Class CsvExporter _ Inherits ExporterBase
public ref class CsvExporter : public ExporterBase
Members| All Members | Constructors | Methods | Properties | Events | |
| Icon | Member | Description |
|---|---|---|
 | CsvExporter()()() |
Initializes a new instance of the CsvExporter class.
|
 | CsvExporter(String) |
Initializes a new instance of the CsvExporter 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 | (Inherited from ExporterBase.) |
 | ExportProcessed |
Occurs when the exporter finishes processing an Export.
(Inherited from ExporterBase.) |
| ExportProcessException | (Inherited from ExporterBase.) |
| ExportRemovedHandler | (Inherited from ExporterBase.) |
 | Exports |
Gets the Exports associated with the exporter.
(Inherited from ExporterBase.) |
| ExportUpdatedHandler | (Inherited from ExporterBase.) |
| Finalize()()() |
Releases the unmanaged resources before the exporter is reclaimed by GC.
(Inherited from ExporterBase.) |
| FindExport(String) | (Inherited from ExporterBase.) |
| FindListener(String) | (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 | (Inherited from ExporterBase.) |
| StatusUpdate |
Occurs when the exporter want to provide a status update.
(Inherited from ExporterBase.) |
| ToString()()() | (Inherited from Object.) |
Examples
Definition of a sample Export that can be processed by CsvExporter:
CopyC#
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>CsvExport</Name> <Type>Intervaled</Type> <Interval>60</Interval> <Exporter>CsvExporter</Exporter> <Settings> <ExportSetting> <Name>OutputFile</Name> <Value>c:\CsvExportOutput.csv</Value> </ExportSetting> </Settings> <Records> <ExportRecord> <Instance>P2</Instance> <Identifier>1885</Identifier> </ExportRecord> <ExportRecord> <Instance>P2</Instance> <Identifier>2711</Identifier> </ExportRecord> </Records> </Export>
Description of custom settings required by CsvExporter in an Export:
| Setting Name | Setting Description |
|---|---|
| OutputFile | Name of the CSV file (including path) where export data is to be written. |
Inheritance Hierarchy| Object | ||
 | ExporterBase | |
| CsvExporter | |
See Also