ActionAdapterBaseTryGetMinimumNeededMeasurements Method

Attempts to retrieve the minimum needed number of measurements from the frame (as specified by MinimumMeasurementsToUse)

Namespace: GSF.TimeSeries.Adapters
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.257-beta

Syntax

C++

JavaScript

Copy

protected virtual bool TryGetMinimumNeededMeasurements(
	IFrame frame,
	ref IMeasurement[] measurements
)

Protected Overridable Function TryGetMinimumNeededMeasurements ( 
	frame As IFrame,
	ByRef measurements As IMeasurement()
) As Boolean

protected:
virtual bool TryGetMinimumNeededMeasurements(
	IFrame^ frame, 
	array<IMeasurement^>^% measurements
)

abstract TryGetMinimumNeededMeasurements : 
        frame : IFrame * 
        measurements : IMeasurement[] byref -> bool 
override TryGetMinimumNeededMeasurements : 
        frame : IFrame * 
        measurements : IMeasurement[] byref -> bool

function TryGetMinimumNeededMeasurements(frame, measurements);

View Source

Parameters

frame IFrame: Source frame for the measurements
measurements IMeasurement: Return array of measurements

Return Value

Boolean
True if minimum needed number of measurements were returned in measurement array

Remarks

Remember this function will *only* return the minimum needed number of measurements, no more. If you want to use all available measurements in your adapter you should just use Frame.Measurements.Values directly.

Note that the measurements array parameter will be created if the reference is null, otherwise if caller creates array it must be sized to MinimumMeasurementsToUse

Reference

ActionAdapterBase Class

GSF.TimeSeries.Adapters Namespace