|
Concentrator Class |
Represents a BPA PDCstream phasor data concentrator.
Inheritance Hierarchy
SystemObject
GSF.TimeSeriesConcentratorBase
GSF.TimeSeries.AdaptersActionAdapterBase
PhasorProtocolAdaptersPhasorDataConcentratorBase
PhasorProtocolAdapters.BpaPdcStreamConcentrator
GSF.TimeSeriesConcentratorBase
GSF.TimeSeries.AdaptersActionAdapterBase
PhasorProtocolAdaptersPhasorDataConcentratorBase
PhasorProtocolAdapters.BpaPdcStreamConcentrator
Namespace: PhasorProtocolAdapters.BpaPdcStream
Assembly: PhasorProtocolAdapters (in PhasorProtocolAdapters.dll) Version: 2.4.218-beta
Syntaxpublic class Concentrator : PhasorDataConcentratorBase
The Concentrator type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Concentrator | Initializes a new instance of the Concentrator class |
Properties| Name | Description | |
|---|---|---|
 | ActiveConnections |
Gets the total number of active socket connections.
(Inherited from PhasorDataConcentratorBase) |
| AllowPreemptivePublishing |
Gets or sets flag that allows system to preemptively publish frames assuming all ExpectedMeasurements have arrived.
(Inherited from ConcentratorBase) |
| AllowSortsByArrival |
Gets or sets flag that determines whether or not to allow incoming measurements with bad timestamps
to be sorted by arrival time.
(Inherited from ConcentratorBase) |
| AnalogScalingValue |
Gets or sets the integer scaling value to apply to analog values published by this PhasorDataConcentratorBase.
(Inherited from PhasorDataConcentratorBase) |
| AutoPublishConfigurationFrame |
Gets or sets flag that determines if configuration frame should be automatically published at the top
of each minute on the data channel.
(Inherited from PhasorDataConcentratorBase) |
| AutoStart |
Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand.
(Inherited from ActionAdapterBase) |
| AutoStartDataChannel |
Gets or sets flag that determines if concentrator will automatically start data channel.
(Inherited from PhasorDataConcentratorBase) |
| AverageLatency |
Gets the average latency in milliseconds over the last test interval.
(Inherited from PhasorDataConcentratorBase) |
| AverageMeasurementsPerSecond |
Gets the average value of the measurements per second calculation.
(Inherited from PhasorDataConcentratorBase) |
| AveragePublicationTimePerFrame |
Gets the average required frame publication time, in seconds.
(Inherited from ConcentratorBase) |
| BaseConfigurationFrame |
Gets the protocol independent ConfigurationFrame defined for this PhasorDataConcentratorBase.
(Inherited from PhasorDataConcentratorBase) |
 | CommandChannel |
Gets or sets reference to TcpServer command channel, attaching and/or detaching to events as needed.
(Inherited from PhasorDataConcentratorBase) |
| ConfigurationFrame |
Gets or sets the protocol specific IConfigurationFrame used to send to clients for protocol parsing.
(Inherited from PhasorDataConcentratorBase) |
| ConnectedClientCount |
Gets the current number of known connected clients on the command channel.
(Inherited from PhasorDataConcentratorBase) |
| ConnectionInfo |
Gets connection info for adapter, if any.
(Inherited from ActionAdapterBase) |
| ConnectionString |
Gets or sets key/value pair connection information specific to action adapter.
(Inherited from ActionAdapterBase) |
| CoordinateFormat |
Gets or sets the CoordinateFormat defined for this PhasorDataConcentratorBase.
(Inherited from PhasorDataConcentratorBase) |
| CurrentScalingValue |
Gets or sets the integer scaling value to apply to current values published by this PhasorDataConcentratorBase.
(Inherited from PhasorDataConcentratorBase) |
| DataChannel |
Gets or sets reference to UdpServer data channel, attaching and/or detaching to events as needed.
(Inherited from PhasorDataConcentratorBase) |
| DataFormat |
Gets or sets the DataFormat defined for this PhasorDataConcentratorBase.
(Inherited from PhasorDataConcentratorBase) |
| DataSource |
Gets or sets DataSet based data source available to this PhasorDataConcentratorBase.
(Inherited from PhasorDataConcentratorBase) |
| DigitalMaskValue |
Gets or sets the digital mask value made available in configuration frames for use with digital values published by this PhasorDataConcentratorBase.
(Inherited from PhasorDataConcentratorBase) |
| DiscardedMeasurements |
Gets the total number of measurements that have been discarded because of old timestamps
(i.e., measurements that were outside the time deviation tolerance from base time, past or future).
(Inherited from ConcentratorBase) |
| DownsampledMeasurements |
Gets the total number of down-sampled measurements processed by the concentrator.
(Inherited from ConcentratorBase) |
| DownsamplingMethod |
Gets or sets the DownsamplingMethod to be used by the concentrator.
(Inherited from ConcentratorBase) |
| Enabled |
Gets or sets the current enabled state of concentrator.
(Inherited from ConcentratorBase) |
| ExpectedMeasurements |
Gets or sets the expected number of measurements to be assigned to a single frame.
(Inherited from ConcentratorBase) |
| FramesAheadOfSchedule |
Gets the total number of frames ahead of schedule processed by the concentrator.
(Inherited from ConcentratorBase) |
| FramesPerSecond |
Gets or sets the number of frames per second.
(Inherited from ActionAdapterBase) |
| ID |
Gets or sets numeric ID associated with this action adapter.
(Inherited from ActionAdapterBase) |
| IDCode |
Gets ID code defined for this PhasorDataConcentratorBase parsed from the ConnectionString.
(Inherited from PhasorDataConcentratorBase) |
| IgnoreBadTimestamps |
Gets or sets flag that determines if bad timestamps (as determined by measurement's timestamp quality)
should be ignored when sorting measurements.
(Inherited from ConcentratorBase) |
| IniFileName | Gets or sets the INI based configuration file name of this Concentrator. |
| InitializationTimeout |
Gets or sets maximum time system will wait during Start for initialization.
(Inherited from ActionAdapterBase) |
| Initialized |
Gets or sets flag indicating if the action adapter has been initialized successfully.
(Inherited from ActionAdapterBase) |
| InputMeasurementKeys |
Gets or sets primary keys of input measurements the action adapter expects.
(Inherited from ActionAdapterBase) |
| InputSourceIDs |
Gets or sets Source values used to filter input measurement keys.
(Inherited from ActionAdapterBase) |
| IsDisposed |
Gets a flag that indicates whether the object has been disposed.
(Inherited from ActionAdapterBase) |
| LagTicks |
Gets defined past time deviation tolerance, in ticks.
(Inherited from ConcentratorBase) |
| LagTime |
Gets or sets the allowed past time deviation tolerance, in seconds (can be sub-second).
(Inherited from ActionAdapterBase) |
| LastDiscardedMeasurement |
Gets a reference the last IMeasurement that was discarded by the concentrator.
(Inherited from ConcentratorBase) |
| LastDiscardedMeasurementLatency |
Gets the calculated latency of the last IMeasurement that was discarded by the concentrator.
(Inherited from ConcentratorBase) |
| LastFrame |
Gets reference to the last published IFrame.
(Inherited from ConcentratorBase) |
| LatestMeasurements |
Gets reference to the collection of absolute latest received measurement values.
(Inherited from ConcentratorBase) |
| LeadTime |
Gets or sets the allowed future time deviation tolerance, in seconds (can be sub-second).
(Inherited from ActionAdapterBase) |
| LifetimeAverageLatency |
Gets the average latency calculated over the full lifetime of the output stream.
(Inherited from PhasorDataConcentratorBase) |
| LifetimeMaximumLatency |
Gets the maximum latency calculated over the full lifetime of the output stream.
(Inherited from PhasorDataConcentratorBase) |
| LifetimeMeasurements |
Gets the total number of measurements processed through this output stream over the lifetime of the output stream.
(Inherited from PhasorDataConcentratorBase) |
| LifetimeMinimumLatency |
Gets the minimum latency calculated over the full lifetime of the output stream.
(Inherited from PhasorDataConcentratorBase) |
| Log |
Log messages generated by an adapter.
(Inherited from ConcentratorBase) |
| MaximumLabelLength |
Gets the maximum label length for string fields in configuration frames.
(Inherited from PhasorDataConcentratorBase) |
| MaximumLatency |
Gets the maximum latency in milliseconds over the last test interval.
(Inherited from PhasorDataConcentratorBase) |
| MaximumMeasurementsPerSecond |
Gets the maximum value of the measurements per second calculation.
(Inherited from PhasorDataConcentratorBase) |
| MaximumPublicationTimeout |
Gets or sets the maximum frame publication timeout in milliseconds, set to Infinite(-1) to wait indefinitely.
(Inherited from ConcentratorBase) |
| MeasurementsSortedByArrival |
Gets the total number of measurements that were sorted by arrival because the measurement reported a bad timestamp quality.
(Inherited from ConcentratorBase) |
| MinimumLatency |
Gets the minimum latency in milliseconds over the last test interval.
(Inherited from PhasorDataConcentratorBase) |
| MinimumMeasurementsPerSecond |
Gets the minimum value of the measurements per second calculation.
(Inherited from PhasorDataConcentratorBase) |
| MinimumMeasurementsToUse |
Gets or sets minimum number of input measurements required for adapter. Set to -1 to require all.
(Inherited from ActionAdapterBase) |
| MissedSortsByTimeout |
Gets the total number of missed sorts by timeout processed by the concentrator.
(Inherited from ConcentratorBase) |
| Name |
Gets name of the action adapter.
(Inherited from ActionAdapterBase) |
| NominalFrequency |
Gets or sets the nominal LineFrequency defined for this PhasorDataConcentratorBase.
(Inherited from PhasorDataConcentratorBase) |
| OutputMeasurements |
Gets or sets output measurements that the action adapter will produce, if any.
(Inherited from ActionAdapterBase) |
| OutputSourceIDs |
Gets or sets Source values used to filter output measurements.
(Inherited from ActionAdapterBase) |
| PerformTimestampReasonabilityCheck |
Gets or sets flag that determines if timestamp reasonability checks should be performed on incoming
measurements (i.e., measurement timestamps are compared to system clock for reasonability using
LeadTime tolerance).
(Inherited from ConcentratorBase) |
| ProcessByReceivedTimestamp |
Gets or sets flag that determines if concentrator should sort measurements by received time.
(Inherited from ConcentratorBase) |
| ProcessDataValidFlag |
Gets or sets flag that determines if the data valid flag assignments should be processed during frame publication.
(Inherited from PhasorDataConcentratorBase) |
| ProcessedMeasurements |
Gets the total number of measurements successfully sorted.
(Inherited from ConcentratorBase) |
| ProcessingInterval |
Gets or sets the desired processing interval, in milliseconds, for the adapter.
(Inherited from ConcentratorBase) |
| PublishChannel |
Gets reference to current IServer publication channel.
(Inherited from PhasorDataConcentratorBase) |
| PublishedFrames |
Gets the total number of published frames.
(Inherited from ConcentratorBase) |
| PublishedMeasurements |
Gets the total number of published measurements.
(Inherited from ConcentratorBase) |
| QueueState |
Gets detailed state of concentrator frame queue.
(Inherited from ConcentratorBase) |
| RealTime |
Gets the most accurate time value that is available. If UseLocalClockAsRealTime = true, then
this function will return UtcNow. Otherwise, this function will return the timestamp of the
most recent measurement, or UtcNow if no measurement timestamps are within time deviation
tolerances as specified by the LeadTime value.
(Inherited from ConcentratorBase) |
| ReceivedMeasurements |
Gets the total number of measurements ever requested for sorting.
(Inherited from ConcentratorBase) |
| ReplaceWithSpaceChar |
Gets or sets character that will be replaced with a space in output labels.
(Inherited from PhasorDataConcentratorBase) |
| RequestedInputMeasurementKeys |
Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from ActionAdapterBase) |
| RequestedOutputMeasurementKeys |
Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide.
(Inherited from ActionAdapterBase) |
| RespectInputDemands |
Gets or sets flag indicating if action adapter should respect auto-start requests based on input demands.
(Inherited from ActionAdapterBase) |
| RespectOutputDemands |
Gets or sets flag indicating if action adapter should respect auto-start requests based on output demands.
(Inherited from ActionAdapterBase) |
| RoundToNearestTimestamp |
Gets or sets a value to indicate whether the concentrator should round to the
nearest frame timestamp rather than rounding down to the nearest timestamps.
(Inherited from ConcentratorBase) |
| RunTime |
Gets the total amount of time, in seconds, that the concentrator has been active.
(Inherited from ConcentratorBase) |
| Settings |
Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
(Inherited from ActionAdapterBase) |
| ShowConcentratorStatus |
Gets flags that determines if ConcentratorBase class status should be included in ActionAdapterBase status.
(Inherited from ActionAdapterBase) |
| SignalReferences |
Gets a reference to the signal reference dictionary for the output stream targets, i.e.,
a source MeasurementKey to target SignalReference array map.
(Inherited from PhasorDataConcentratorBase) |
| StartTime |
Gets the UTC time the concentrator was started.
(Inherited from ConcentratorBase) |
| StartTimeConstraint |
Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from ActionAdapterBase) |
| Status |
Returns the detailed status of this Concentrator.
(Overrides PhasorDataConcentratorBaseStatus) |
| StopTime |
Gets the UTC time the concentrator was stopped.
(Inherited from ConcentratorBase) |
| StopTimeConstraint |
Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String).
(Inherited from ActionAdapterBase) |
| SupportsTemporalProcessing |
Gets the flag indicating if this adapter supports temporal processing.
(Inherited from PhasorDataConcentratorBase) |
| TicksPerFrame |
Gets the number of ticks per frame.
(Inherited from ConcentratorBase) |
| TimeResolution |
Gets or sets the maximum time resolution, in ticks, to use when sorting measurements by timestamps into their proper destination frame.
(Inherited from ConcentratorBase) |
| TotalBytesSent |
Gets the total number of bytes sent to clients of this output stream.
(Inherited from PhasorDataConcentratorBase) |
| TotalPublicationTime |
Gets the total number of seconds frames have spent in the publication process since concentrator started.
(Inherited from ConcentratorBase) |
| TrackLatestMeasurements |
Gets or sets flag to start tracking the absolute latest received measurement values.
(Inherited from ConcentratorBase) |
| UseLocalClockAsRealTime |
Gets or sets flag that determines whether or not to use the local clock time as real-time.
(Inherited from ConcentratorBase) |
| UsePrecisionTimer |
Gets or sets flag that determines if precision timer should be used for frame publication.
(Inherited from ConcentratorBase) |
| VoltageScalingValue |
Gets or sets the integer scaling value to apply to voltage values published by this PhasorDataConcentratorBase.
(Inherited from PhasorDataConcentratorBase) |
| WaitHandleExpirations |
Gets the total number of wait handle expirations encountered due to delayed precision timer releases.
(Inherited from ConcentratorBase) |
Methods| Name | Description | |
|---|---|---|
 | AssignMeasurementToFrame |
Assign IMeasurement to its IFrame.
(Inherited from PhasorDataConcentratorBase) |
| CacheConfigurationFrame |
Serialize configuration frame to cache folder for later use (if needed).
(Inherited from PhasorDataConcentratorBase) |
 | CreateDataFrame | Creates a new BPA PDCstream specific DataFrame for the given timestamp. |
| CreateNewConfigurationFrame |
Creates a new BPA PDCstream specific IConfigurationFrame based on provided protocol independent baseConfigurationFrame.
(Overrides PhasorDataConcentratorBaseCreateNewConfigurationFrame(ConfigurationFrame)) |
| CreateNewFrame |
Creates a new BPA PDCstream specific DataFrame for the given timestamp.
(Overrides ConcentratorBaseCreateNewFrame(Ticks)) |
| DeviceCommandHandler |
Handles incoming commands from devices connected over the command channel.
(Inherited from PhasorDataConcentratorBase) |
| Dispose |
Releases all the resources used by the ConcentratorBase object.
(Inherited from ConcentratorBase) |
| Dispose(Boolean) |
Releases the unmanaged resources used by the PhasorDataConcentratorBase object and optionally releases the managed resources.
(Inherited from PhasorDataConcentratorBase) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExamineQueueState |
Examines the concentrator frame queue state of the ActionAdapterBase.
(Inherited from ActionAdapterBase) |
| Finalize |
Releases the unmanaged resources before the ConcentratorBase object is reclaimed by GC.
(Inherited from ConcentratorBase) |
| GetConnectionID |
Gets connection ID (i.e., IP:Port) for specified clientID.
(Inherited from PhasorDataConcentratorBase) |
| GetHashCode |
Returns the hash code for this instance.
(Inherited from PhasorDataConcentratorBase) |
| GetShortStatus |
Gets a short one-line status of this ActionAdapterBase.
(Inherited from ActionAdapterBase) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Initialize |
Initializes Concentrator.
(Overrides PhasorDataConcentratorBaseInitialize) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MillisecondsFromRealTime |
Returns the deviation, in milliseconds, that the given number of ticks is from real-time (i.e., RealTime).
(Inherited from ConcentratorBase) |
| OnConfigurationChanged |
Raises ConfigurationChanged event.
(Inherited from ActionAdapterBase) |
| OnDiscardingMeasurements |
Raises the DiscardingMeasurements event.
(Inherited from ConcentratorBase) |
| OnInputMeasurementKeysUpdated |
Raises InputMeasurementKeysUpdated event.
(Inherited from ActionAdapterBase) |
| OnNewMeasurements |
Raises the NewMeasurements event.
(Inherited from ActionAdapterBase) |
| OnOutputMeasurementsUpdated |
Raises OutputMeasurementsUpdated event.
(Inherited from ActionAdapterBase) |
| OnProcessException(Exception) | Obsolete. Raises the ProcessException event. (Inherited from ConcentratorBase) |
| OnProcessException(MessageLevel, Exception, String, MessageFlags) |
Raises the ProcessException event.
(Inherited from ConcentratorBase) |
| OnStatusMessage(String) | Obsolete. Raises the StatusMessage event. (Inherited from ActionAdapterBase) |
| OnStatusMessage(String, Object) | Obsolete. Raises the StatusMessage event with a formatted status message. (Inherited from ActionAdapterBase) |
| OnStatusMessage(MessageLevel, String, String, MessageFlags) |
Raises the StatusMessage event and sends this data to the Logger.
(Inherited from ActionAdapterBase) |
| OnUnpublishedSamples |
Raises the UnpublishedSamples event.
(Inherited from ConcentratorBase) |
| PublishConfigFrame |
Execute the publish operation for a configuration frame.
(Inherited from PhasorDataConcentratorBase) |
| PublishFrame |
Publish IFrame of time-aligned collection of IMeasurement values that arrived within the
concentrator's defined LagTime.
(Inherited from PhasorDataConcentratorBase) |
| QueueMeasurementsForProcessing |
Queues a collection of measurements for processing.
(Inherited from PhasorDataConcentratorBase) |
| ResetLatencyCounters |
Resets counters related to latency calculations.
(Inherited from PhasorDataConcentratorBase) |
| ResetLifetimeCounters |
Resets the counters for the lifetime statistics without interrupting the adapter's operations.
(Inherited from PhasorDataConcentratorBase) |
| ResetStatistics |
Resets the statistics of the ActionAdapterBase.
(Inherited from ActionAdapterBase) |
| SecondsFromRealTime |
Returns the deviation, in seconds, that the given number of ticks is from real-time (i.e., RealTime).
(Inherited from ConcentratorBase) |
| SetInitializedState |
Manually sets the initialized state of the ActionAdapterBase.
(Inherited from ActionAdapterBase) |
| SetTemporalConstraint |
Defines a temporal processing constraint for the adapter.
(Inherited from ActionAdapterBase) |
| SortMeasurement |
Sorts the IMeasurement placing the data point in its proper IFrame.
(Inherited from ConcentratorBase) |
| SortMeasurements |
Sorts each IMeasurement placing each data point in its proper IFrame.
(Inherited from ConcentratorBase) |
| Start |
Starts the PhasorDataConcentratorBase, if it is not already running.
(Inherited from PhasorDataConcentratorBase) |
| StartDataChannel |
Starts the PhasorDataConcentratorBase real-time data stream.
(Inherited from PhasorDataConcentratorBase) |
| Stop |
Stops the PhasorDataConcentratorBase.
(Inherited from PhasorDataConcentratorBase) |
| StopDataChannel |
Stops the PhasorDataConcentratorBase real-time data stream.
(Inherited from PhasorDataConcentratorBase) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TryGetMinimumNeededMeasurements |
Attempts to retrieve the minimum needed number of measurements from the frame (as specified by MinimumMeasurementsToUse)
(Inherited from ActionAdapterBase) |
| UpdateConfiguration |
Reloads the configuration for this PhasorDataConcentratorBase.
(Inherited from PhasorDataConcentratorBase) |
Events| Name | Description | |
|---|---|---|
 | ConfigurationChanged |
Event is raised when adapter is aware of a configuration change.
(Inherited from ActionAdapterBase) |
| DiscardingMeasurements |
This event is raised if there are any measurements being discarded during the sorting process.
(Inherited from ConcentratorBase) |
| Disposed |
This event is raised when ConcentratorBase is disposed.
(Inherited from ConcentratorBase) |
| InputMeasurementKeysUpdated |
Event is raised when InputMeasurementKeys are updated.
(Inherited from ActionAdapterBase) |
| NewMeasurements |
Provides new measurements from action adapter.
(Inherited from ActionAdapterBase) |
| OutputMeasurementsUpdated |
Event is raised when OutputMeasurements are updated.
(Inherited from ActionAdapterBase) |
| ProcessException |
This event is raised if there is an exception encountered while attempting to process a frame in the sample queue.
(Inherited from ConcentratorBase) |
| StatusMessage |
Provides status messages to consumer.
(Inherited from ActionAdapterBase) |
| UnpublishedSamples |
This event is raised every 5 seconds allowing consumer to track current number of unpublished seconds of data in the queue.
(Inherited from ConcentratorBase) |
See Also