1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
package cgeo.geocaching.sensors;
import org.apache.commons.lang3.tuple.ImmutablePair;
import rx.Observable;
import rx.Subscription;
import rx.android.schedulers.AndroidSchedulers;
import rx.functions.Action1;
import rx.functions.Func2;
import rx.subscriptions.CompositeSubscription;
import java.util.concurrent.TimeUnit;
/**
* GeoData and Direction handler.
* <p>
* To use this class, override {@link #updateGeoDir(cgeo.geocaching.sensors.GeoData, float)}. You need to start the handler using
* {@link #start(int)}. A good place to do so might be the {@code onResume} method of the Activity. Stop the Handler
* accordingly in {@code onPause}.
*
* The direction is always relative to the top of the device (natural direction), and that it must
* be fixed using {@link cgeo.geocaching.utils.AngleUtils#getDirectionNow(float)}. When the direction is derived from the GPS,
* it is altered so that the fix can still be applied as if the information came from the compass.
*/
public abstract class GeoDirHandler {
public static final int UPDATE_GEODATA = 1 << 1;
public static final int UPDATE_DIRECTION = 1 << 2;
public static final int UPDATE_GEODIR = 1 << 3;
public static final int LOW_POWER = 1 << 4;
/**
* Update method called when new geodata is available. This method is called on the UI thread.
* {@link #start(int)} must be called with the {@link #UPDATE_GEODATA} flag set.
*
* @param geoData the new geographical data
*/
public void updateGeoData(final GeoData geoData) {
}
/**
* Update method called when new direction is available. This method is called on the UI thread.
* {@link #start(int)} must be called with the {@link #UPDATE_DIRECTION} flag set.
*
* @param direction the new direction
*/
public void updateDirection(final float direction) {
}
/**
* Update method called when new data is available. This method is called on the UI thread.
* {@link #start(int)} must be called with the {@link #UPDATE_GEODIR} flag set.
*
* @param geoData the new geographical data
* @param direction the new direction
*
* If the device goes fast enough, or if the compass use is not enabled in the settings,
* the GPS direction information will be used instead of the compass one.
*/
public void updateGeoDir(final GeoData geoData, final float direction) {
}
private static <T> Observable<T> throttleIfNeeded(final Observable<T> observable, final long windowDuration, final TimeUnit unit) {
return windowDuration > 0 ? observable.throttleFirst(windowDuration, unit) : observable;
}
/**
* Register the current GeoDirHandler for GeoData and direction information (if the preferences allow it).
*
* @param flags a combination of UPDATE_GEODATA, UPDATE_DIRECTION, UPDATE_GEODIR, and LOW_POWER
* @return a subscription which can be used to stop the handler
*/
public Subscription start(final int flags) {
return start(flags, 0, TimeUnit.SECONDS);
}
/**
* Register the current GeoDirHandler for GeoData and direction information (if the preferences allow it).
*
* @param flags a combination of UPDATE_GEODATA, UPDATE_DIRECTION, UPDATE_GEODIR, and LOW_POWER
* @param windowDuration if greater than 0, the size of the window duration during which no new value will be presented
* @param unit the unit for the windowDuration
* @return a subscription which can be used to stop the handler
*/
public Subscription start(final int flags, final long windowDuration, final TimeUnit unit) {
final CompositeSubscription subscriptions = new CompositeSubscription();
final boolean lowPower = (flags & LOW_POWER) != 0;
final Sensors sensors = Sensors.getInstance();
if ((flags & UPDATE_GEODATA) != 0) {
subscriptions.add(throttleIfNeeded(sensors.geoDataObservable(lowPower), windowDuration, unit).observeOn(AndroidSchedulers.mainThread()).subscribe(new Action1<GeoData>() {
@Override
public void call(final GeoData geoData) {
updateGeoData(geoData);
}
}));
}
if ((flags & UPDATE_DIRECTION) != 0) {
subscriptions.add(throttleIfNeeded(sensors.directionObservable(), windowDuration, unit).observeOn(AndroidSchedulers.mainThread()).subscribe(new Action1<Float>() {
@Override
public void call(final Float direction) {
updateDirection(direction);
}
}));
}
if ((flags & UPDATE_GEODIR) != 0) {
// combineOnLatest() does not implement backpressure handling, so we need to explicitely use a backpressure operator there.
subscriptions.add(throttleIfNeeded(Observable.combineLatest(sensors.geoDataObservable(lowPower), sensors.directionObservable(), new Func2<GeoData, Float, ImmutablePair<GeoData, Float>>() {
@Override
public ImmutablePair<GeoData, Float> call(final GeoData geoData, final Float direction) {
return ImmutablePair.of(geoData, direction);
}
}), windowDuration, unit).onBackpressureDrop().observeOn(AndroidSchedulers.mainThread()).subscribe(new Action1<ImmutablePair<GeoData, Float>>() {
@Override
public void call(final ImmutablePair<GeoData, Float> geoDir) {
updateGeoDir(geoDir.left, geoDir.right);
}
}));
}
return subscriptions;
}
}
|
