SensorBase<TSensorReading> Class

July 28, 2014

The base class for all Windows Phone sensor classes.

Namespace:  Microsoft.Devices.Sensors
Assembly:  Microsoft.Devices.Sensors (in Microsoft.Devices.Sensors.dll)

public abstract class SensorBase<TSensorReading> : IDisposable
where TSensorReading : ISensorReading

Type Parameters

TSensorReading

The type of reading returned by the sensor.

The SensorBase<TSensorReading> type exposes the following members.

  NameDescription
Public propertyCurrentValueGets an object that implements ISensorReading that contains the current value of the sensor. This object will be one of the following types, depending on which sensor is being referenced: AccelerometerReading, CompassReading, GyroscopeReading, MotionReading.
Public propertyIsDataValidGets the validity of the sensor’s data.
Public propertyTimeBetweenUpdatesGets or sets the preferred time between CurrentValueChanged events.
Top

  NameDescription
Public methodDisposeReleases the managed and unmanaged resources used by the sensor.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Overrides Object.Finalize().)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodStartStarts acquisition of data from the sensor.
Public methodStopStops acquisition of data from the sensor.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventCurrentValueChangedOccurs when new data arrives from the sensor.
Top

The following classes that allow access to device sensors inherit from the SensorBase class: Accelerometer, Compass, Gyroscope, Motion.

The Start() and Stop() methods start and stop the sensors associated with each class. To obtain the values from each of these classes, use the CurrentValue property or implement a handler for the CurrentValueChanged event.

Capabilities

If you use this API in your app, you must specify the following capabilities in the app manifest. Otherwise, your app might not work correctly or it might exit unexpectedly.

ID_CAP_SENSORS

Windows Phone 8, Windows Phone OS 7.1

For more info, see App capabilities and hardware requirements for Windows Phone 8.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2014 Microsoft