C# Class openHistorian.MeasurementAPI

Exibir arquivo Open project: GridProtectionAlliance/openHistorian

Public Methods

Method	Description
EstablishMeasurementKeyCache ( DataSet metadata, string instanceName ) : void	Establish measurement key cache based on received meta-data. If you want the IMeasurement.Key values that are returned from a GetHistorianData query to have properly assigned Guid based signal IDs, i.e., MeasurementKey.SignalID, establish the measurement key cache as soon as you have received meta-data from a GEP subscription query.
GetContiguousDataRegions ( Connection connection, System.DateTime startTime, System.DateTime stopTime, ulong measurementID, Resolution resolution, long expectedFullResolutionTicks = 333333 ) : DateTime>>.IEnumerable	Read historian data from server. 1 tick = 100 nanoseconds.
GetHistorianData ( Connection connection, System.DateTime startTime, System.DateTime stopTime, string measurementIDs = null, Resolution resolution = Resolution.Full ) : IEnumerable	Read historian data from server.

Method Details

EstablishMeasurementKeyCache() public static method

Establish measurement key cache based on received meta-data.

If you want the IMeasurement.Key values that are returned from a GetHistorianData query to have properly assigned Guid based signal IDs, i.e., MeasurementKey.SignalID, establish the measurement key cache as soon as you have received meta-data from a GEP subscription query.

public static EstablishMeasurementKeyCache ( DataSet metadata, string instanceName ) : void
metadata	System.Data.DataSet	Meta-data received from a subscription.
instanceName	string	Instance name of the historian.
return	void

GetContiguousDataRegions() public static method

Read historian data from server.

1 tick = 100 nanoseconds.

public static GetContiguousDataRegions ( Connection connection, System.DateTime startTime, System.DateTime stopTime, ulong measurementID, Resolution resolution, long expectedFullResolutionTicks = 333333 ) : DateTime>>.IEnumerable
connection	Connection	openHistorian connection.
startTime	System.DateTime	Start time of query.
stopTime	System.DateTime	Stop time of query.
measurementID	ulong	Measurement ID to test for data continuity.
resolution	Resolution	Resolution for testing data.
expectedFullResolutionTicks	long	Expected number of ticks per interval at full resolution, e.g., 33,333 = 1/30 of a second representing a sampling interval of 30 times per second.
return	DateTime>>.IEnumerable

GetHistorianData() public static method

Read historian data from server.

public static GetHistorianData ( Connection connection, System.DateTime startTime, System.DateTime stopTime, string measurementIDs = null, Resolution resolution = Resolution.Full ) : IEnumerable
connection	Connection	openHistorian connection.
startTime	System.DateTime	Start time of query.
stopTime	System.DateTime	Stop time of query.
measurementIDs	string	Comma separated list of measurement IDs to query - or null for all available points.
resolution	Resolution	Resolution for data query.
return	IEnumerable