SensorBase<(Of <(TSensorReading>)>) Class
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
The base class for all Windows Phone sensor classes.
Inheritance Hierarchy
System..::.Object
Microsoft.Devices.Sensors..::.SensorBase<(Of <(TSensorReading>)>)
Microsoft.Devices.Sensors..::.Accelerometer
Microsoft.Devices.Sensors..::.Compass
Microsoft.Devices.Sensors..::.Gyroscope
Microsoft.Devices.Sensors..::.Motion
Namespace: Microsoft.Devices.Sensors
Assembly: Microsoft.Devices.Sensors (in Microsoft.Devices.Sensors.dll)
Syntax
Public MustInherit Class SensorBase(Of TSensorReading As ISensorReading) _
Implements IDisposable
public abstract class SensorBase<TSensorReading> : IDisposable
where TSensorReading : ISensorReading
Type Parameters
- TSensorReading
The type of reading returned by the sensor.
The SensorBase<(Of <(TSensorReading>)>) type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
CurrentValue | Gets 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. |
|
IsDataValid | Gets the validity of the sensor’s data. |
|
TimeBetweenUpdates | Gets or sets the preferred time between CurrentValueChanged events. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Dispose | Releases the managed and unmanaged resources used by the sensor. |
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
.gif "Protected method") |
Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Overrides Object..::.Finalize()()().) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
Start | Starts acquisition of data from the sensor. |
|
Stop | Stops acquisition of data from the sensor. |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
CurrentValueChanged | Occurs when new data arrives from the sensor. |
Top
Remarks
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.
Version Information
Windows Phone OS
Supported in: 8.1, 8.0, 7.1
Platforms
Windows Phone
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.