C# Class openHistorian.Adapters.TrendValueAPI

Defines an API for publishing TrendValue instances from the openHistorian.
Show file Open project: GridProtectionAlliance/openHistorian Class Usage Examples

Public Methods

Method Description
EstimatePlotResolution ( string instanceName, System.DateTime startTime, System.DateTime stopTime, ulong measurementIDs ) : Resolution

Estimates a decent plot resolution for given time range.
GetHistorianData ( HistorianValue>.ClientDatabaseBase database, System.DateTime startTime, System.DateTime stopTime, ulong measurementIDs, Resolution resolution, int seriesLimit, bool forceLimit, ICancellationToken cancellationToken = null ) : IEnumerable

Read historian data from server.
GetInstanceNames ( ) : IEnumerable

Gets loaded historian adapter instance names.

Private Methods

Method Description
LoadConnectionParameters ( ) : void
TrendValueAPI ( ) : System

Method Details

EstimatePlotResolution() public static method

Estimates a decent plot resolution for given time range.
public static EstimatePlotResolution ( string instanceName, System.DateTime startTime, System.DateTime stopTime, ulong measurementIDs ) : Resolution
instanceName string Historian instance name.
startTime System.DateTime Start time of query.
stopTime System.DateTime Stop time of query.
measurementIDs ulong Measurement IDs being queried - or null for all available points.
return Resolution

GetHistorianData() public static method

Read historian data from server.
public static GetHistorianData ( HistorianValue>.ClientDatabaseBase database, System.DateTime startTime, System.DateTime stopTime, ulong measurementIDs, Resolution resolution, int seriesLimit, bool forceLimit, ICancellationToken cancellationToken = null ) : IEnumerable
database HistorianValue>.ClientDatabaseBase Client database to use for query.
startTime System.DateTime Start time of query.
stopTime System.DateTime Stop time of query.
measurementIDs ulong Measurement IDs to query - or null for all available points.
resolution Resolution Resolution for data query.
seriesLimit int Maximum number of points per series.
forceLimit bool Flag that determines if series limit should be strictly enforced.
cancellationToken ICancellationToken Cancellation token for query.
return IEnumerable

GetInstanceNames() public static method

Gets loaded historian adapter instance names.
public static GetInstanceNames ( ) : IEnumerable
return IEnumerable