1 /*
2  * Copyright (C) 2023 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package android.car.hardware.property;
18 
19 import android.annotation.IntDef;
20 import android.annotation.NonNull;
21 import android.annotation.SystemApi;
22 
23 import java.lang.annotation.Retention;
24 import java.lang.annotation.RetentionPolicy;
25 
26 /**
27  * Used to enumerate the current state of {@link
28  * android.car.VehiclePropertyIds#LANE_DEPARTURE_WARNING_STATE}.
29  *
30  * <p>This list of states may be extended in future releases to include additional states.
31  * @hide
32  */
33 @SystemApi
34 public final class LaneDepartureWarningState {
35     /**
36      * This state is used as an alternative for any {@code LaneDepartureWarningState} value that
37      * is not defined in the platform. Ideally, implementations of {@link
38      * android.car.VehiclePropertyIds#LANE_DEPARTURE_WARNING_STATE} should not use this state.
39      * The framework can use this field to remain backwards compatible if {@code
40      * LaneDepartureWarningState} is extended to include additional states.
41      */
42     public static final int OTHER = 0;
43 
44     /**
45      * LDW is enabled and monitoring, but the vehicle is centered in the lane.
46      */
47     public static final int NO_WARNING = 1;
48 
49     /**
50      * LDW is enabled, detects the vehicle is approaching or crossing lane lines on the left side
51      * of the vehicle, and is currently warning the user.
52      */
53     public static final int WARNING_LEFT = 2;
54 
55     /**
56      * LDW is enabled, detects the vehicle is approaching or crossing lane lines on the right side
57      * of the vehicle, and is currently warning the user.
58      */
59     public static final int WARNING_RIGHT = 3;
60 
LaneDepartureWarningState()61     private LaneDepartureWarningState() {}
62 
63     /**
64      * Returns a user-friendly representation of a {@code LaneDepartureWarningState}.
65      */
66     @NonNull
toString( @aneDepartureWarningStateInt int laneDepartureWarningState)67     public static String toString(
68             @LaneDepartureWarningStateInt int laneDepartureWarningState) {
69         switch (laneDepartureWarningState) {
70             case OTHER:
71                 return "OTHER";
72             case NO_WARNING:
73                 return "NO_WARNING";
74             case WARNING_LEFT:
75                 return "WARNING_LEFT";
76             case WARNING_RIGHT:
77                 return "WARNING_RIGHT";
78             default:
79                 return "0x" + Integer.toHexString(laneDepartureWarningState);
80         }
81     }
82 
83     /** @hide */
84     @IntDef({OTHER, NO_WARNING, WARNING_LEFT, WARNING_RIGHT})
85     @Retention(RetentionPolicy.SOURCE)
86     public @interface LaneDepartureWarningStateInt {}
87 }
88 
89