|
StatisticsEngineTryLookupStatisticSource Method
|
Attempts to lookup statistic source and signal index from a measurement signalReference.
Namespace: GSF.TimeSeries.StatisticsAssembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.207-beta
Syntax public static bool TryLookupStatisticSource(
string signalReference,
out string sourceCategory,
out int signalIndex
)
static member TryLookupStatisticSource :
signalReference : string *
sourceCategory : string byref *
signalIndex : int byref -> bool
GSF.TimeSeries.Statistics.StatisticsEngine.TryLookupStatisticSource = function(signalReference, sourceCategory, signalIndex);
View SourceParameters
- signalReference String
- Signal reference.
- sourceCategory String
- Statistic source category as defined in Statistics table Source column.
- signalIndex Int32
- Statistic signal index as defined in Statistics table SignalIndex column.
Return Value
Booleantrue if lookup succeeds; otherwise,
false.
Remarks
The statistic source acronyms used in measurement signal references are defined dynamically by
statistic sources during registration. This function returns the source category, as defined in
the Statistic table, for a given signal reference to allow for reverse lookups. As a result,
user will need to make sure that all statistic sources have been registered before calling
this function in order to receive accurate results.
See Also