openPDC Historian Help
DataMonitorExporter Class
Namespaces ► TVA.Historian.Exporters ► DataMonitorExporter
Represents an exporter that can export real-time time-series data over a TCP server socket.
Declaration Syntax
C#Visual BasicVisual C++
public class DataMonitorExporter : RebroadcastExporter
Public Class DataMonitorExporter _
	Inherits RebroadcastExporter
public ref class DataMonitorExporter : public RebroadcastExporter
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
DataMonitorExporter()()()
Initializes a new instance of the DataMonitorExporter class.

DataMonitorExporter(String)
Initializes a new instance of the DataMonitorExporter 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.
(Inherited from RebroadcastExporter.)
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.
(Inherited from RebroadcastExporter.)
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.)
TransmitData(Export, IList<(Of <(IDataPoint>)>))
Performs the transmission of time-series data for the export.
(Overrides RebroadcastExporter.TransmitData(Export, IList<(Of <(IDataPoint>)>)).)
Examples
Definition of a sample Export that can be processed by DataMonitorExporter:
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>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
ServerPort
TCP 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.

Inheritance Hierarchy
Object
ExporterBase
 RebroadcastExporter
  DataMonitorExporter
See Also
Export

Assembly: TVA.Historian (Module: TVA.Historian) Version: 1.0.33.39252