xref: /packages/services/Car/car-support-lib/src/android/support/car/hardware/CarSensorConfig.java

/*
 * Copyright (C) 2017 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.support.car.hardware;

import static androidx.annotation.RestrictTo.Scope.GROUP_ID;

import android.os.Bundle;

import androidx.annotation.RestrictTo;

/**
 * A CarSensorConfig object corresponds to a single sensor type coming from the car.
 * @hide
 */
public class CarSensorConfig {
    /** List of property specific mapped elements in bundle for WHEEL_TICK_DISTANCE sensor*/
    /** @hide */
    public final static String WHEEL_TICK_DISTANCE_SUPPORTED_WHEELS =
        "android.car.wheelTickDistanceSupportedWheels";
    /** @hide */
    public final static String WHEEL_TICK_DISTANCE_FRONT_LEFT_UM_PER_TICK =
        "android.car.wheelTickDistanceFrontLeftUmPerTick";
    /** @hide */
    public final static String WHEEL_TICK_DISTANCE_FRONT_RIGHT_UM_PER_TICK =
        "android.car.wheelTickDistanceFrontRightUmPerTick";
    /** @hide */
    public final static String WHEEL_TICK_DISTANCE_REAR_RIGHT_UM_PER_TICK =
        "android.car.wheelTickDistanceRearRightUmPerTick";
    /** @hide */
    public final static String WHEEL_TICK_DISTANCE_REAR_LEFT_UM_PER_TICK =
        "android.car.wheelTickDistanceRearLeftUmPerTick";

    /** Config data stored in Bundle */
    private final Bundle mConfig;
    private final int mType;

    private final static int RAW_BUNDLE_SIZE = 4;
    private final static int WHEEL_TICK_DISTANCE_BUNDLE_SIZE = 6;

    /**
     * Constructs a {@link CarSensorConfig}. Handled by CarSensorManager implementations.
     * App developers need not worry about constructing these objects.
     * @hide
     */
    @RestrictTo(GROUP_ID)
    public CarSensorConfig(int type, Bundle in) {
        mType = type;
        mConfig = in.deepCopy();
    }

    private void checkType(int type) {
        if (mType == type) {
            return;
        }
        throw new UnsupportedOperationException(String.format(
            "Invalid sensor type: expected %d, got %d", type, mType));
    }

    /** @hide */
    public int getInt(String key) {
        if (mConfig.containsKey(key)) {
            return mConfig.getInt(key);
        } else {
            throw new IllegalArgumentException("SensorType " + mType +
                " does not contain key: " + key);
        }
    }

    /** @hide */
    public int getType() {
        return mType;
    }

    /** @hide */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append(getClass().getName() + "[");
        sb.append("mConfig: " + mConfig.toString());
        sb.append("mType: " + mType);
        sb.append("]");
        return sb.toString();
    }
}