CustomSensor.ReportInterval Property

public:
 property unsigned int ReportInterval { unsigned int get(); void set(unsigned int value); };

uint32_t ReportInterval();

void ReportInterval(uint32_t value);

public uint ReportInterval { get; set; }

var uInt32 = customSensor.reportInterval;
customSensor.reportInterval = uInt32;

Public Property ReportInterval As UInteger

Property Value

The current report interval for the sensor.

Remarks

The report interval is specified in milliseconds.

The report interval will be set to a default value that will vary based on the sensor driver’s implementation. If your app doesn't want to use this default value, set the report interval to a non-zero value prior to registering an event handler or calling GetCurrentReading. The sensor will then attempt to allocate resources to satisfy the app’s requirements but the sensor also has to balance the needs of other apps using the sensor.

Changes to the report interval after an event handler has been registered or GetCurrentReading has been called may apply to the delivery of subsequent sensor readings.

Conversely, when an app is finished with the sensor, we recommend that it explicitly return the sensor to its default report interval by setting it to zero. This is important for power conservation, especially when using a language that may keep the sensor object active for an indefinite period prior to garbage collection.

We recommend that the app consult the MinimumReportInterval property prior to setting the report interval to ensure that the sensor can honor the requested report interval. Setting a value below the minimum supported interval will either trigger an exception or have undefined results.

Although the app can set this value to request a particular report interval, the driver will determine the actual report interval, based on internal logic. For example, the driver might use the shortest report interval that is requested by any caller.

Setting a value of zero requests the driver to use its default report interval. As with requesting a specific interval, the driver may choose a different interval based on other client requests and internal logic.

The custom sensor platform automatically sets the change sensitivity for custom sensors based on the current report interval. This table specifies the change sensitivity values for given intervals.

Applies to