|
CommonPhasorServicesGetCurrentMeasurementValue Method
|
Gets the current measurement value for the specified measurement.
Namespace: PhasorProtocolAdaptersAssembly: PhasorProtocolAdapters (in PhasorProtocolAdapters.dll) Version: 2.4.207-beta
Syntax [AdapterCommandAttribute("Gets current measurement value.", new string[] { ... })]
public double GetCurrentMeasurementValue(
string measurementID
)
<AdapterCommandAttribute("Gets current measurement value.", New String() { ... })>
Public Function GetCurrentMeasurementValue (
measurementID As String
) As Double
public:
[AdapterCommandAttribute(L"Gets current measurement value.", __gc new array<String^>^ { ... })]
double GetCurrentMeasurementValue(
String^ measurementID
)
[<AdapterCommandAttribute("Gets current measurement value.", new string[] { ... })>]
member GetCurrentMeasurementValue :
measurementID : string -> float
function GetCurrentMeasurementValue(measurementID);
View SourceParameters
- measurementID String
- Measurement identifier, e.g., filter expression, measurement key, Guid-based signal ID, or point tag.
Return Value
DoubleCurrent measurement value for the specified measurement; otherwise
NaN if not available.
Remarks
Initial call will attempt to load latest measurement value from the service host cache. Specified
measurement will be cached and continue to be updated with matching active new measurements for up
to one minute. If cached measurement values are not queried within one minute, they will be removed
from the cache. Subsequent calls for measurement after cache expiration will attempt to reload latest
measurement from the service host cache again, however, only statistic values are commonly cached by
the service host. As such it is recommended to query for measurement updates at intervals that are
more frequent than one minute to keep the measurement value updated from newly received measurements.
See Also