C# Class openHistorian.Adapters.HistorianQueryHubClient

Represents a client instance of a SignalR Hub for historian data queries.
Inheritance: GSF.Web.Hubs.HubClientBase
Show file Open project: GridProtectionAlliance/openHistorian

Public Methods

Method Description
GetHistorianData ( string instanceName, System.DateTime startTime, System.DateTime stopTime, ulong measurementIDs, Resolution resolution, int seriesLimit, bool forceLimit ) : IEnumerable

Read historian data from server.
GetInstanceNames ( ) : IEnumerable

Gets loaded historian adapter instance names.
GetSelectedInstanceName ( ) : string

Gets selected instance name.
HistorianQueryHubClient ( ) : System

Creates a new HistorianQueryHubClient.
SetSelectedInstanceName ( string instanceName ) : void

Set selected instance name.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

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

Private Methods

Method Description
GetConnection ( string instanceName ) : SnapClient
GetDatabase ( string instanceName ) : HistorianValue>.ClientDatabaseBase

Method Details

Dispose() protected method

Releases the unmanaged resources used by the HistorianQueryHubClient 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

GetHistorianData() public method

Read historian data from server.
public GetHistorianData ( string instanceName, System.DateTime startTime, System.DateTime stopTime, ulong measurementIDs, Resolution resolution, int seriesLimit, bool forceLimit ) : IEnumerable
instanceName string Historian instance name.
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.
return IEnumerable

GetInstanceNames() public method

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

GetSelectedInstanceName() public method

Gets selected instance name.
public GetSelectedInstanceName ( ) : string
return string

HistorianQueryHubClient() public method

Creates a new HistorianQueryHubClient.
public HistorianQueryHubClient ( ) : System
return System

SetSelectedInstanceName() public method

Set selected instance name.
public SetSelectedInstanceName ( string instanceName ) : void
instanceName string Instance name that is selected by user.
return void