1.7.13.4 FREQM_IsBusy Function

C

bool FREQM_IsBusy(void)

Summary

Returns the measurement status of an on-going frequency measurement operation.

Description

This function returns the measurement status of an on-going frequency measurement operation. The function returns true when the FREQM_MeasurementStart() function has been called to start a measurement. It returns false, when the measurement operation has completed. The function should be called after measurement operation was initiated to poll the completion of the measurement operation. It also can be used as alternate to callback.

Precondition

The FREQM_Initialize() function must have been called.

Parameters

None.

Returns

true - Module is busy with a measurement.

false - Module is not busy with a measurement.

Example

FREQM_MeasurementStart();

// Wait till the measurement is complete.
while(FREQM_IsBusy());

Remarks

None.