Click or drag to resize

DataMonitorExporter Class
Represents an exporter that can export real-time time-series data over a TCP server socket.
Inheritance Hierarchy
SystemObject
  GSF.Historian.ExportersExporterBase
    GSF.Historian.ExportersRebroadcastExporter
      GSF.Historian.ExportersDataMonitorExporter

Namespace: GSF.Historian.Exporters
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.230-beta
Syntax
Copy
public class DataMonitorExporter : RebroadcastExporter
View Source

The DataMonitorExporter type exposes the following members.

Constructors
 NameDescription
Public methodDataMonitorExporter Initializes a new instance of the DataMonitorExporter class.
Protected methodDataMonitorExporter(String) Initializes a new instance of the DataMonitorExporter 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 ProcessQueueT 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 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)
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.
(Inherited from RebroadcastExporter)
Public methodProcessExport(String) Processes Export with the specified exportName.
(Inherited from ExporterBase)
Protected methodProcessRealTimeData Handles the DataExtracted event for all the Listeners.
(Inherited from ExporterBase)
Protected methodProcessRealTimeExport Processes the export using the real-time data.
(Inherited from RebroadcastExporter)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Protected methodTransmitData Performs the transmission of time-series data for the export.
(Overrides RebroadcastExporterTransmitData(Export, IListIDataPoint))
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 MethodGetEnumValueOrDefaultT 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 DataMonitorExporter:
C#
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>DataMonitorExport</Name>
  <Type>RealTime</Type>
  <Interval>0</Interval>
  <Exporter>DataMonitorExporter</Exporter>
  <Settings>
    <ExportSetting>
      <Name>ServerPort</Name>
      <Value>8500</Value>
    </ExportSetting>
    <ExportSetting>
      <Name>LegacyMode</Name>
      <Value>True</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 DataMonitorExporter in an Export:
Setting NameSetting Description
ServerPortTCP server socket port number over which export data is to be transmitted.
LegacyMode (Optional)True if export data is to be transmitted in PacketType1 and False if export data is to be transmitted in PacketType101.

See Also