PhasorMeasurementMapper Class

SystemObject
  GSF.TimeSeries.AdaptersAdapterBase
    GSF.TimeSeries.AdaptersInputAdapterBase
      PhasorProtocolAdaptersPhasorMeasurementMapper

[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public class PhasorMeasurementMapper : InputAdapterBase

<EditorBrowsableAttribute(EditorBrowsableState.Never)>
Public Class PhasorMeasurementMapper
	Inherits InputAdapterBase

[EditorBrowsableAttribute(EditorBrowsableState::Never)]
public ref class PhasorMeasurementMapper : public InputAdapterBase

[<EditorBrowsableAttribute(EditorBrowsableState.Never)>]
type PhasorMeasurementMapper = 
    class
        inherit InputAdapterBase
    end

PhasorProtocolAdapters.PhasorMeasurementMapper = function();

Type.createClass(
	'PhasorProtocolAdapters.PhasorMeasurementMapper',
	GSF.TimeSeries.Adapters.InputAdapterBase);

View Source

	Name	Description
	PhasorMeasurementMapper	Creates a new PhasorMeasurementMapper.

Top

	Name	Description
	AccessID	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.
	ActualDataRate	Gets the actual data rate.
	ActualFrameRate	Gets the actual frame rate.
	AllowUseOfCachedConfiguration	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.
	AutoStart	Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand. (Inherited from AdapterBase)
	AverageLatency	Gets the average latency in milliseconds over the last test interval.
	AverageMeasurementsPerSecond	Gets the average value of the measurements per second calculation.
	ConfigurationCacheFileName	Gets the configuration cache file name, with path.
	ConfigurationChanges	Gets the total number of received configurations.
	ConfigurationOutOfSync	Gets flag that determines if host configuration is out of sync with connected device.
	ConnectionAttemptInterval	Gets or sets the connection attempt interval, in milliseconds, for the data input source. (Inherited from InputAdapterBase)
	ConnectionAttempts	Gets the total number of connection attempts.
	ConnectionInfo	Gets connection info for adapter, if any. (Overrides AdapterBaseConnectionInfo)
	ConnectionString	Gets or sets key/value pair connection information specific to this AdapterBase. (Inherited from AdapterBase)
	CRCErrors	Gets the total number of CRC errors that have been encountered by the current mapper connection.
	DataSource	Gets or sets DataSet based data source available to this AdapterBase. (Inherited from AdapterBase)
	DefinedDevices	Gets an enumeration of all defined system devices (regardless of ID or label based definition)
	DefinedFrameRate	Gets the defined frame rate.
	EnableConnectionErrors	When false, this adapter will not log any connection errors through OnProcessException. When true, all errors get logged.
	Enabled	Gets or sets enabled state of this AdapterBase. (Inherited from AdapterBase)
	FrameParser	Gets or sets reference to MultiProtocolFrameParser, attaching and/or detaching to events as needed.
	ID	Gets or sets numeric ID associated with this AdapterBase. (Inherited from AdapterBase)
	InitializationTimeout	Gets or sets maximum time system will wait during Start for initialization. (Inherited from AdapterBase)
	Initialized	Gets or sets flag indicating if the adapter has been initialized successfully. (Inherited from AdapterBase)
	InputMeasurementKeys	Gets or sets primary keys of input measurements the AdapterBase expects, if any. (Inherited from InputAdapterBase)
	IsConcentrator	Gets flag that determines if device being mapped is a concentrator (i.e., data from multiple devices combined together from the connected device).
	IsConnected	Gets flag that determines if InputAdapterBase is connected. (Inherited from InputAdapterBase)
	IsDisposed	Gets a flag that indicates whether the object has been disposed. (Inherited from AdapterBase)
	JsonConfigurationPath	Gets the path to the configuration cache directory.
	LastReportTime	Gets or set last report time for current mapper connection.
	LifetimeAverageLatency	Gets the average latency calculated over the full lifetime of the input stream.
	LifetimeMaximumLatency	Gets the maximum latency calculated over the full lifetime of the input stream.
	LifetimeMeasurements	Gets the total number of measurements processed through this data publisher over the lifetime of the input stream.
	LifetimeMinimumLatency	Gets the minimum latency calculated over the full lifetime of the input stream.
	Log	Log messages generated by an adapter. (Inherited from AdapterBase)
	MaximumLatency	Gets the maximum latency in milliseconds over the last test interval.
	MaximumMeasurementsPerSecond	Gets the maximum value of the measurements per second calculation.
	MeasurementReportingInterval	Gets or sets the measurement reporting interval. (Inherited from AdapterBase)
	MinimumLatency	Gets the minimum latency in milliseconds over the last test interval.
	MinimumMeasurementsPerSecond	Gets the minimum value of the measurements per second calculation.
	MissingData	Gets the number of missing frames of data, taking into account redundant frames.
	MissingFrames	Gets the total number of frames that have been missed by the current mapper connection.
	Name	Gets or sets the name of this AdapterBase. (Inherited from AdapterBase)
	OutOfOrderFrames	Gets the total number frames that came in out of order from the current mapper connection.
	OutputMeasurements	Gets or sets output measurements that the AdapterBase will produce, if any. (Inherited from AdapterBase)
	OutputSourceIDs	Gets or sets Source values used to filter output measurements. (Inherited from InputAdapterBase)
	ProcessedMeasurements	Gets the total number of measurements handled thus far by the AdapterBase. (Inherited from AdapterBase)
	ProcessingInterval	Gets or sets the desired processing interval, in milliseconds, for the adapter. (Inherited from AdapterBase)
	RequestedOutputMeasurementKeys	Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide. (Inherited from InputAdapterBase)
	RunTime	Gets the total amount of time, in seconds, that the adapter has been active. (Inherited from AdapterBase)
	Settings	Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned. (Inherited from AdapterBase)
	SharedMapping	Gets or sets acronym of other device for which to assume a shared mapping.
	SharedMappingID	Returns ID of associated device with shared mapping or ID of this PhasorMeasurementMapper if no shared mapping is defined.
	StartTime	Gets the UTC time this AdapterBase was started. (Inherited from AdapterBase)
	StartTimeConstraint	Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String). (Inherited from AdapterBase)
	Status	Returns the detailed status of the data input source. (Overrides InputAdapterBaseStatus)
	StopTime	Gets the UTC time this AdapterBase was stopped. (Inherited from AdapterBase)
	StopTimeConstraint	Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String). (Inherited from AdapterBase)
	SupportsTemporalProcessing	Gets the flag indicating if this adapter supports temporal processing. (Overrides AdapterBaseSupportsTemporalProcessing)
	TcpClientPublishChannel	Gets or sets reference to TcpClient publication channel, attaching and/or detaching to events as needed.
	TcpPublishChannel	Gets or sets reference to TcpServer publication channel, attaching and/or detaching to events as needed.
	TimeAdjustmentTicks	Gets or sets ticks used to manually adjust time of this PhasorMeasurementMapper.
	TimeZone	Gets or sets time zone of this PhasorMeasurementMapper.
	TotalBytesReceived	Gets total data packet bytes received during this session.
	TotalConfigurationFrames	Gets the total number of received configuration frames.
	TotalDataFrames	Gets the total number of received data frames.
	TotalFrames	Gets the total number of frames that have been received by the current mapper connection.
	TotalHeaderFrames	Gets the total number of received header frames.
	UdpPublishChannel	Gets or sets reference to UdpServer publication channel, attaching and/or detaching to events as needed.
	UseAsyncConnect	Gets flag that determines if the data input connects asynchronously. (Overrides InputAdapterBaseUseAsyncConnect)

Top

	Name	Description
	AttemptConnection	Attempts to connect to data input source. (Overrides InputAdapterBaseAttemptConnection)
	AttemptDisconnection	Attempts to disconnect from data input source. (Overrides InputAdapterBaseAttemptDisconnection)
	DeleteCachedConfiguration	Attempts to delete the last known good (i.e., cached) configuration.
	DeviceCommandHandler	Handles incoming commands from devices connected over the command channel. This is used by data-forwarding feature,
	Dispose	Releases all the resources used by the AdapterBase object. (Inherited from AdapterBase)
	Dispose(Boolean)	Releases the unmanaged resources used by the PhasorMeasurementMapper object and optionally releases the managed resources. (Overrides InputAdapterBaseDispose(Boolean))
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	ExtractFrameMeasurements	Extract frame measurements and add expose them via the NewMeasurements event.
	Finalize	Releases the unmanaged resources before the AdapterBase object is reclaimed by GC. (Inherited from AdapterBase)
	GetConnectionID	Gets connection ID (i.e., IP:Port) for specified clientID.
	GetHashCode	Serves as a hash function for the current AdapterBase. (Inherited from AdapterBase)
	GetShortStatus	Gets a short one-line status of this PhasorMeasurementMapper. (Overrides AdapterBaseGetShortStatus(Int32))
	GetSignalReference(SignalKind)	Get signal reference for specified SignalKind.
	GetSignalReference(SignalKind, Int32, Int32)	Get signal reference for specified SignalKind and index.
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IncrementProcessedMeasurements	Safely increments the total processed measurements. (Inherited from AdapterBase)
	Initialize	Initializes PhasorMeasurementMapper. (Overrides InputAdapterBaseInitialize)
	LoadCachedConfiguration	Attempts to load the last known good (i.e., cached) configuration.
	LoadConfiguration	Attempts to load the specified configuration.
	LoadConfigurationOutOfSyncMarker	Loads flag that determines if device configuration has changed since last update in host system.
	MapMeasurementAttributes	Map parsed measurement value to defined measurement attributes (i.e., assign meta-data to parsed measured value).
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnConfigurationChanged	Raises ConfigurationChanged event. (Inherited from AdapterBase)
	OnConnected	Called when data input source connection is established. (Inherited from InputAdapterBase)
	OnDisconnected	Called when data input source is disconnected. (Inherited from InputAdapterBase)
	OnInputMeasurementKeysUpdated	Raises InputMeasurementKeysUpdated event. (Inherited from AdapterBase)
	OnNewMeasurements	Raises the NewMeasurements event. (Inherited from InputAdapterBase)
	OnOutputMeasurementsUpdated	Raises OutputMeasurementsUpdated event. (Inherited from AdapterBase)
	OnProcessException(Exception)	Obsolete. Raises the ProcessException event. (Inherited from AdapterBase)
	OnProcessException(MessageLevel, Exception, String, MessageFlags)	Raises the ProcessException event. (Inherited from AdapterBase)
	OnProcessingComplete	Raises the ProcessingComplete event. (Inherited from InputAdapterBase)
	OnStatusMessage(String)	Obsolete. Raises the StatusMessage event. (Inherited from AdapterBase)
	OnStatusMessage(String, Object)	Obsolete. Raises the StatusMessage event with a formatted status message. (Inherited from AdapterBase)
	OnStatusMessage(MessageLevel, String, String, MessageFlags)	Raises the StatusMessage event and sends this data to the Logger. (Inherited from AdapterBase)
	RequestCurrentConfiguration	Returns the current configuration frame to the caller.
	ResetDeviceStatistics	Resets the statistics of the specified device associated with this connection.
	ResetLatencyCounters	Resets counters related to latency calculations.
	ResetLifetimeCounters	Resets the counters for the lifetime statistics without interrupting the adapter's operations.
	ResetStatistics	Resets the statistics of all devices associated with this connection.
	SaveConfigurationOutOfSyncMarker	Persists flag that determines if device configuration has changed since last update in host system.
	SendCommand	Sends the specified DeviceCommand to the current device connection.
	SetInitializedState	Manually sets the initialized state of the AdapterBase. (Inherited from AdapterBase)
	SetTemporalConstraint	Defines a temporal processing constraint for the adapter. (Inherited from AdapterBase)
	Start	Starts this InputAdapterBase and initiates connection cycle to data input source. (Inherited from InputAdapterBase)
	Stop	Stops this InputAdapterBase and disconnects from data input source. (Inherited from InputAdapterBase)
	ToggleBadData	Toggles the flag that determines whether to inject the bad data state flag into the stream.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

	Name	Description
	ConfigurationChanged	Event is raised when adapter is aware of a configuration change. (Inherited from AdapterBase)
	Disposed	Event is raised when AdapterBase is disposed. (Inherited from AdapterBase)
	InputMeasurementKeysUpdated	Event is raised when InputMeasurementKeys are updated. (Inherited from AdapterBase)
	NewMeasurements	Provides new measurements from input adapter. (Inherited from InputAdapterBase)
	OutputMeasurementsUpdated	Event is raised when OutputMeasurements are updated. (Inherited from AdapterBase)
	ProcessException	Event is raised when there is an exception encountered while processing. (Inherited from AdapterBase)
	ProcessingComplete	Indicates to the host that processing for the input adapter has completed. (Inherited from InputAdapterBase)
	StatusMessage	Provides status messages to consumer. (Inherited from AdapterBase)

Top

Reference

PhasorProtocolAdapters Namespace