C# Class PIAdapters.PIPBInputAdapter

Retrieves PI data for non-real time temporal sessions. The real-time PI input adapter is preferred for real-time data due to use of event pipes.
Inheritance: InputAdapterBase
Mostrar archivo Open project: GridProtectionAlliance/gsf

Private Properties

Property Type Description
ConvertStatusFlags MeasurementStateFlags
ReadData IEnumerable
StartDataReader void
m_readTimer_Elapsed void

Public Methods

Method Description
GetShortStatus ( int maxLength ) : string

Gets a short one-line status of this PIAdapters.PIPBInputAdapter.
Initialize ( ) : void

Initializes this PIAdapters.PIPBInputAdapter.
PIPBInputAdapter ( ) : System

Creates a new instance of the PIAdapters.PIPBInputAdapter.

Protected Methods

Method Description
AttemptConnection ( ) : void

Attempts to connect to this PIAdapters.PIPBInputAdapter.
AttemptDisconnection ( ) : void

Attempts to disconnect from this PIAdapters.PIPBInputAdapter.
Dispose ( bool disposing ) : void

Releases the unmanaged resources used by the PIAdapters.PIPBInputAdapter object and optionally releases the managed resources.

Private Methods

Method Description
ConvertStatusFlags ( AFValueStatus status ) : MeasurementStateFlags
ReadData ( AFTime startTime, AFTime endTime ) : IEnumerable
StartDataReader ( object state ) : void
m_readTimer_Elapsed ( object sender, System.Timers.ElapsedEventArgs e ) : void

Method Details

AttemptConnection() protected method

Attempts to connect to this PIAdapters.PIPBInputAdapter.
protected AttemptConnection ( ) : void
return void

AttemptDisconnection() protected method

Attempts to disconnect from this PIAdapters.PIPBInputAdapter.
protected AttemptDisconnection ( ) : void
return void

Dispose() protected method

Releases the unmanaged resources used by the PIAdapters.PIPBInputAdapter object and optionally releases the managed resources.
protected Dispose ( bool disposing ) : void
disposing bool true to release both managed and unmanaged resources; false to release only unmanaged resources.
return void

GetShortStatus() public method

Gets a short one-line status of this PIAdapters.PIPBInputAdapter.
public GetShortStatus ( int maxLength ) : string
maxLength int Maximum length of the status message.
return string

Initialize() public method

Initializes this PIAdapters.PIPBInputAdapter.
HistorianID, Server, Port, Protocol, or InitiateConnection is missing from the .
public Initialize ( ) : void
return void

PIPBInputAdapter() public method

Creates a new instance of the PIAdapters.PIPBInputAdapter.
public PIPBInputAdapter ( ) : System
return System