|
PIRTInput
|
Uses PI event pipes to deliver real-time PI data to GSF host
Inheritance Hierarchy
SystemObject
GSF.TimeSeries.AdaptersAdapterBase
GSF.TimeSeries.AdaptersInputAdapterBase
PIAdaptersPIRTInputAdapter
GSF.TimeSeries.AdaptersAdapterBase
GSF.TimeSeries.AdaptersInputAdapterBase
PIAdaptersPIRTInputAdapter
Namespace: PIAdapters
Assembly: PIAdapters (in PIAdapters.dll) Version: 2.4.181-beta
SyntaxThe PIRTInputAdapter type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PIRTInputAdapter | Receives real-time updates from PI |
Properties| Name | Description | |
|---|---|---|
 | AutoStart |
Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand.
(Inherited from AdapterBase) |
 | ConnectionAttemptInterval |
Gets or sets the connection attempt interval, in milliseconds, for the data input source.
(Inherited from InputAdapterBase) |
| ConnectionInfo |
Gets connection info for adapter, if any.
(Inherited from AdapterBase) |
| ConnectionString |
Gets or sets key/value pair connection information specific to this AdapterBase.
(Inherited from AdapterBase) |
| ConnectTimeout | Gets or sets the timeout interval (in milliseconds) for the adapter's connection |
| DataSource |
Gets or sets DataSet based data source available to this AdapterBase.
(Inherited from AdapterBase) |
| EnableConnectionErrors |
When false, connection errors do not get logged through OnProcessException. When true, connection errors will be logged normally.
(Inherited from InputAdapterBase) |
| Enabled |
Gets or sets enabled state of this AdapterBase.
(Inherited from AdapterBase) |
| 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) |
| 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) |
| LastReceivedTimestamp | Last timestamp received from PI |
| Log |
Log messages generated by an adapter.
(Inherited from AdapterBase) |
| MeasurementReportingInterval |
Gets or sets the measurement reporting interval.
(Inherited from AdapterBase) |
| Name |
Gets or sets the name of this AdapterBase.
(Inherited from AdapterBase) |
| 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) |
| Password | Gets or sets the password used for the adapter's PI connection. |
| 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 the measurements that this PIRTInputAdapter has been requested to provide
(Overrides InputAdapterBaseRequestedOutputMeasurementKeys) |
| RunTime |
Gets the total amount of time, in seconds, that the adapter has been active.
(Inherited from AdapterBase) |
| ServerName | Gets or sets the name of the PI server for the adapter's PI connection. |
| Settings |
Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned.
(Inherited from AdapterBase) |
| 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 status of the adapter
(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 |
Returns false to indicate that this PIRTInputAdapter does NOT support temporal processing.
Temporal processing is supported in a separate adapter that is not driven by event pipes.
(Overrides AdapterBaseSupportsTemporalProcessing) |
| UseAsyncConnect |
Returns false to indicate that this PIRTInputAdapter does NOT connect asynchronously
(Overrides InputAdapterBaseUseAsyncConnect) |
| UserName | Gets or sets the name of the PI user ID for the adapter's PI connection. |
Methods| Name | Description | |
|---|---|---|
 | AttemptConnection |
Connects to the configured PI server.
(Overrides InputAdapterBaseAttemptConnection) |
| AttemptDisconnection |
Disconnects from the configured PI server if a connection is open
(Overrides InputAdapterBaseAttemptDisconnection) |
| Dispose |
Releases all the resources used by the AdapterBase object.
(Inherited from AdapterBase) |
| Dispose(Boolean) |
Releases the unmanaged resources used by the PIRTInputAdapter 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) |
| Finalize |
Releases the unmanaged resources before the AdapterBase object is reclaimed by GC.
(Inherited from AdapterBase) |
| GetHashCode |
Serves as a hash function for the current AdapterBase.
(Inherited from AdapterBase) |
| GetShortStatus |
Returns brief status with measurements processed
(Overrides AdapterBaseGetShortStatus(Int32)) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IncrementProcessedMeasurements |
Safely increments the total processed measurements.
(Inherited from AdapterBase) |
| Initialize |
Reads values from the connection string and prepares this PIRTInputAdapter for connecting to PI
(Overrides InputAdapterBaseInitialize) |
| 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) |
| 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) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Events| 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) |
See Also