Click or drag to resize
Grid Solutions Framework

PhasorMeasurementMapper Class

Represents an IInputAdapter used to map measured values from a connection to a phasor measurement device to new IMeasurement values.
Inheritance Hierarchy
SystemObject
  GSF.TimeSeries.AdaptersAdapterBase
    GSF.TimeSeries.AdaptersInputAdapterBase
      PhasorProtocolAdaptersPhasorMeasurementMapper

Namespace: PhasorProtocolAdapters
Assembly: PhasorProtocolAdapters (in PhasorProtocolAdapters.dll) Version: 2.4.177-beta
Syntax
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public class PhasorMeasurementMapper : InputAdapterBase
View Source

The PhasorMeasurementMapper type exposes the following members.

Constructors
 NameDescription
Public methodPhasorMeasurementMapper Creates a new PhasorMeasurementMapper.
Top
Properties
 NameDescription
Public propertyAccessID Gets the access ID (a.k.a, ID code) for this device connection. Value is often necessary in order to make a connection to some phasor protocols.
Public propertyActualDataRate Gets the actual data rate.
Public propertyActualFrameRate Gets the actual frame rate.
Public propertyAllowUseOfCachedConfiguration Gets or sets flag that determines if use of cached configuration during initial connection is allowed when a configuration has not been received within the data loss interval.
Public propertyAutoStart Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand.
(Inherited from AdapterBase)
Public propertyAverageLatency Gets the average latency in milliseconds over the last test interval.
Public propertyAverageMeasurementsPerSecond Gets the average value of the measurements per second calculation.
Public propertyConfigurationCacheFileName Gets the configuration cache file name, with path.
Public propertyConfigurationChanges Gets the total number of received configurations.
Public propertyConfigurationOutOfSync Gets flag that determines if host configuration is out of sync with connected device.
Protected propertyConnectionAttemptInterval Gets or sets the connection attempt interval, in milliseconds, for the data input source.
(Inherited from InputAdapterBase)
Public propertyConnectionAttempts Gets the total number of connection attempts.
Public propertyConnectionInfo Gets connection info for adapter, if any.
(Overrides AdapterBaseConnectionInfo)
Public propertyConnectionString Gets or sets key/value pair connection information specific to this AdapterBase.
(Inherited from AdapterBase)
Public propertyCRCErrors Gets the total number of CRC errors that have been encountered by the current mapper connection.
Public propertyDataSource Gets or sets DataSet based data source available to this AdapterBase.
(Inherited from AdapterBase)
Public propertyDefinedDevices Gets an enumeration of all defined system devices (regardless of ID or label based definition)
Public propertyDefinedFrameRate Gets the defined frame rate.
Public propertyEnableConnectionErrors When false, this adapter will not log any connection errors through OnProcessException. When true, all errors get logged.
Public propertyEnabled Gets or sets enabled state of this AdapterBase.
(Inherited from AdapterBase)
Protected propertyFrameParser Gets or sets reference to MultiProtocolFrameParser, attaching and/or detaching to events as needed.
Public propertyID Gets or sets numeric ID associated with this AdapterBase.
(Inherited from AdapterBase)
Public propertyInitializationTimeout Gets or sets maximum time system will wait during Start for initialization.
(Inherited from AdapterBase)
Public propertyInitialized Gets or sets flag indicating if the adapter has been initialized successfully.
(Inherited from AdapterBase)
Public propertyInputMeasurementKeys Gets or sets primary keys of input measurements the AdapterBase expects, if any.
(Inherited from InputAdapterBase)
Public propertyIsConcentrator Gets flag that determines if device being mapped is a concentrator (i.e., data from multiple devices combined together from the connected device).
Public propertyIsConnected Gets flag that determines if InputAdapterBase is connected.
(Inherited from InputAdapterBase)
Public propertyIsDisposed Gets a flag that indicates whether the object has been disposed.
(Inherited from AdapterBase)
Public propertyStatic memberJsonConfigurationPath Gets the path to the configuration cache directory.
Public propertyLastReportTime Gets or set last report time for current mapper connection.
Public propertyLifetimeAverageLatency Gets the average latency calculated over the full lifetime of the input stream.
Public propertyLifetimeMaximumLatency Gets the maximum latency calculated over the full lifetime of the input stream.
Public propertyLifetimeMeasurements Gets the total number of measurements processed through this data publisher over the lifetime of the input stream.
Public propertyLifetimeMinimumLatency Gets the minimum latency calculated over the full lifetime of the input stream.
Protected propertyLog Log messages generated by an adapter.
(Inherited from AdapterBase)
Public propertyMaximumLatency Gets the maximum latency in milliseconds over the last test interval.
Public propertyMaximumMeasurementsPerSecond Gets the maximum value of the measurements per second calculation.
Public propertyMeasurementReportingInterval Gets or sets the measurement reporting interval.
(Inherited from AdapterBase)
Public propertyMinimumLatency Gets the minimum latency in milliseconds over the last test interval.
Public propertyMinimumMeasurementsPerSecond Gets the minimum value of the measurements per second calculation.
Public propertyMissingData Gets the number of missing frames of data, taking into account redundant frames.
Public propertyMissingFrames Gets the total number of frames that have been missed by the current mapper connection.
Public propertyName Gets or sets the name of this AdapterBase.
(Inherited from AdapterBase)
Public propertyOutOfOrderFrames Gets the total number frames that came in out of order from the current mapper connection.
Public propertyOutputMeasurements Gets or sets output measurements that the AdapterBase will produce, if any.
(Inherited from AdapterBase)
Public propertyOutputSourceIDs Gets or sets Source values used to filter output measurements.
(Inherited from InputAdapterBase)
Public propertyProcessedMeasurements Gets the total number of measurements handled thus far by the AdapterBase.
(Inherited from AdapterBase)
Public propertyProcessingInterval Gets or sets the desired processing interval, in milliseconds, for the adapter.
(Inherited from AdapterBase)
Public propertyRequestedOutputMeasurementKeys Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from InputAdapterBase)
Public propertyRunTime Gets the total amount of time, in seconds, that the adapter has been active.
(Inherited from AdapterBase)
Public propertySettings Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
(Inherited from AdapterBase)
Public propertySharedMapping Gets or sets acronym of other device for which to assume a shared mapping.
Public propertySharedMappingID Returns ID of associated device with shared mapping or ID of this PhasorMeasurementMapper if no shared mapping is defined.
Public propertyStartTime Gets the UTC time this AdapterBase was started.
(Inherited from AdapterBase)
Public propertyStartTimeConstraint Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterBase)
Public propertyStatus Returns the detailed status of the data input source.
(Overrides InputAdapterBaseStatus)
Public propertyStopTime Gets the UTC time this AdapterBase was stopped.
(Inherited from AdapterBase)
Public propertyStopTimeConstraint Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from AdapterBase)
Public propertySupportsTemporalProcessing Gets the flag indicating if this adapter supports temporal processing.
(Overrides AdapterBaseSupportsTemporalProcessing)
Protected propertyTcpClientPublishChannel Gets or sets reference to TcpClient publication channel, attaching and/or detaching to events as needed.
Protected propertyTcpPublishChannel Gets or sets reference to TcpServer publication channel, attaching and/or detaching to events as needed.
Public propertyTimeAdjustmentTicks Gets or sets ticks used to manually adjust time of this PhasorMeasurementMapper.
Public propertyTimeZone Gets or sets time zone of this PhasorMeasurementMapper.
Public propertyTotalBytesReceived Gets total data packet bytes received during this session.
Public propertyTotalConfigurationFrames Gets the total number of received configuration frames.
Public propertyTotalDataFrames Gets the total number of received data frames.
Public propertyTotalFrames Gets the total number of frames that have been received by the current mapper connection.
Public propertyTotalHeaderFrames Gets the total number of received header frames.
Protected propertyUdpPublishChannel Gets or sets reference to UdpServer publication channel, attaching and/or detaching to events as needed.
Protected propertyUseAsyncConnect Gets flag that determines if the data input connects asynchronously.
(Overrides InputAdapterBaseUseAsyncConnect)
Top
Methods
 NameDescription
Protected methodAttemptConnection Attempts to connect to data input source.
(Overrides InputAdapterBaseAttemptConnection)
Protected methodAttemptDisconnection Attempts to disconnect from data input source.
(Overrides InputAdapterBaseAttemptDisconnection)
Public methodDeleteCachedConfiguration Attempts to delete the last known good (i.e., cached) configuration.
Protected methodDeviceCommandHandler Handles incoming commands from devices connected over the command channel. This is used by data-forwarding feature,
Public methodDispose Releases all the resources used by the AdapterBase object.
(Inherited from AdapterBase)
Protected methodDispose(Boolean) Releases the unmanaged resources used by the PhasorMeasurementMapper object and optionally releases the managed resources.
(Overrides InputAdapterBaseDispose(Boolean))
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodExtractFrameMeasurements Extract frame measurements and add expose them via the NewMeasurements event.
Protected methodFinalize Releases the unmanaged resources before the AdapterBase object is reclaimed by GC.
(Inherited from AdapterBase)
Protected methodGetConnectionID Gets connection ID (i.e., IP:Port) for specified clientID.
Public methodGetHashCode Serves as a hash function for the current AdapterBase.
(Inherited from AdapterBase)
Public methodGetShortStatus Gets a short one-line status of this PhasorMeasurementMapper.
(Overrides AdapterBaseGetShortStatus(Int32))
Public methodGetSignalReference(SignalKind) Get signal reference for specified SignalKind.
Public methodGetSignalReference(SignalKind, Int32, Int32) Get signal reference for specified SignalKind and index.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodIncrementProcessedMeasurements Safely increments the total processed measurements.
(Inherited from AdapterBase)
Public methodInitialize Initializes PhasorMeasurementMapper.
(Overrides InputAdapterBaseInitialize)
Public methodLoadCachedConfiguration Attempts to load the last known good (i.e., cached) configuration.
Public methodLoadConfiguration Attempts to load the specified configuration.
Public methodStatic memberLoadConfigurationOutOfSyncMarker Loads flag that determines if device configuration has changed since last update in host system.
Protected methodMapMeasurementAttributes Map parsed measurement value to defined measurement attributes (i.e., assign meta-data to parsed measured value).
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnConfigurationChanged Raises ConfigurationChanged event.
(Inherited from AdapterBase)
Protected methodOnConnected Called when data input source connection is established.
(Inherited from InputAdapterBase)
Protected methodOnDisconnected Called when data input source is disconnected.
(Inherited from InputAdapterBase)
Protected methodOnInputMeasurementKeysUpdated Raises InputMeasurementKeysUpdated event.
(Inherited from AdapterBase)
Protected methodOnNewMeasurements Raises the NewMeasurements event.
(Inherited from InputAdapterBase)
Protected methodOnOutputMeasurementsUpdated Raises OutputMeasurementsUpdated event.
(Inherited from AdapterBase)
Protected methodOnProcessException(Exception)Obsolete.
Raises the ProcessException event.
(Inherited from AdapterBase)
Protected methodOnProcessException(MessageLevel, Exception, String, MessageFlags) Raises the ProcessException event.
(Inherited from AdapterBase)
Protected methodOnProcessingComplete Raises the ProcessingComplete event.
(Inherited from InputAdapterBase)
Protected methodOnStatusMessage(String)Obsolete.
Raises the StatusMessage event.
(Inherited from AdapterBase)
Protected methodOnStatusMessage(String, Object)Obsolete.
Raises the StatusMessage event with a formatted status message.
(Inherited from AdapterBase)
Protected methodOnStatusMessage(MessageLevel, String, String, MessageFlags) Raises the StatusMessage event and sends this data to the Logger.
(Inherited from AdapterBase)
Public methodRequestCurrentConfiguration Returns the current configuration frame to the caller.
Public methodResetDeviceStatistics Resets the statistics of the specified device associated with this connection.
Public methodResetLatencyCounters Resets counters related to latency calculations.
Public methodResetLifetimeCounters Resets the counters for the lifetime statistics without interrupting the adapter's operations.
Public methodResetStatistics Resets the statistics of all devices associated with this connection.
Public methodStatic memberSaveConfigurationOutOfSyncMarker Persists flag that determines if device configuration has changed since last update in host system.
Public methodSendCommand Sends the specified DeviceCommand to the current device connection.
Public methodSetInitializedState Manually sets the initialized state of the AdapterBase.
(Inherited from AdapterBase)
Public methodSetTemporalConstraint Defines a temporal processing constraint for the adapter.
(Inherited from AdapterBase)
Public methodStart Starts this InputAdapterBase and initiates connection cycle to data input source.
(Inherited from InputAdapterBase)
Public methodStop Stops this InputAdapterBase and disconnects from data input source.
(Inherited from InputAdapterBase)
Public methodToggleBadData Toggles the flag that determines whether to inject the bad data state flag into the stream.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventConfigurationChanged Event is raised when adapter is aware of a configuration change.
(Inherited from AdapterBase)
Public eventDisposed Event is raised when AdapterBase is disposed.
(Inherited from AdapterBase)
Public eventInputMeasurementKeysUpdated Event is raised when InputMeasurementKeys are updated.
(Inherited from AdapterBase)
Public eventNewMeasurements Provides new measurements from input adapter.
(Inherited from InputAdapterBase)
Public eventOutputMeasurementsUpdated Event is raised when OutputMeasurements are updated.
(Inherited from AdapterBase)
Public eventProcessException Event is raised when there is an exception encountered while processing.
(Inherited from AdapterBase)
Public eventProcessingComplete Indicates to the host that processing for the input adapter has completed.
(Inherited from InputAdapterBase)
Public eventStatusMessage Provides status messages to consumer.
(Inherited from AdapterBase)
Top
See Also