Gemstone Timeseries Library
Statistics
Attempts to lookup statistic source and signal index from a measurement signalReference.
Definition
Namespace: Gemstone.Timeseries.Statistics
Assembly: Gemstone.Timeseries (in Gemstone.Timeseries.dll) Version: 1.0.136 -- Release Build+045677775a56d15698be6ced5ce5213063e47102
true if lookup succeeds; otherwise, false.
Assembly: Gemstone.Timeseries (in Gemstone.Timeseries.dll) Version: 1.0.136 -- Release Build+045677775a56d15698be6ced5ce5213063e47102
C#
public static bool TryLookupStatisticSource(
string signalReference,
out string?? sourceCategory,
out int signalIndex
)VB
Public Shared Function TryLookupStatisticSource (
signalReference As String,
<OutAttribute> ByRef sourceCategory As String,
<OutAttribute> ByRef signalIndex As Integer
) As BooleanC++
public:
static bool TryLookupStatisticSource(
String^ signalReference,
[OutAttribute] String^% sourceCategory,
[OutAttribute] int% signalIndex
)JavaScript
Gemstone.Timeseries.Statistics.StatisticsEngine.TryLookupStatisticSource = function(signalReference, sourceCategory, signalIndex);Parameters
- 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.