/*
 * Copyright 2021 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 androidx.car.app.hardware.info;

import static java.util.Objects.requireNonNull;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.car.app.annotations.CarProtocol;
import androidx.car.app.annotations.RequiresCarApi;
import androidx.car.app.hardware.common.CarValue;
import androidx.car.app.annotations.KeepFields;

import java.util.List;
import java.util.Objects;

/** Information about car specific compass available from the car hardware. */
@CarProtocol
@RequiresCarApi(3)
@KeepFields
public final class Compass {
    @NonNull
    private final CarValue<List<Float>> mOrientations;

    /**
     * Returns the raw compass data from the car sensor.
     *
     * <p>Individual values can be {@code Float.Nan} if not reported. The array values consist of:
     * <ul>
     *     <li>[0]: Azimuth, angle between the magnetic north direction and the y-axis, around the
     *     z-axis (0 to 359). 0=North, 90=East, 180=South, 270=West
     *     <li>[1]: Pitch, rotation around y-axis (-90 to 90), where nose down is positive
     *     <li>[2]: Roll, rotation around x-axis (-180 to 180), where right door down is positive
     * </ul>
     */
    @NonNull
    public CarValue<List<Float>> getOrientations() {
        return mOrientations;
    }

    @Override
    @NonNull
    public String toString() {
        return "[ orientations: " + mOrientations + " ]";
    }

    @Override
    public int hashCode() {
        return Objects.hash(mOrientations);
    }

    @Override
    public boolean equals(@Nullable Object other) {
        if (this == other) {
            return true;
        }
        if (!(other instanceof Compass)) {
            return false;
        }
        Compass otherCompass = (Compass) other;

        return Objects.equals(mOrientations, otherCompass.mOrientations);
    }

    /**
     * Creates an {@link Compass} with the given raw data.
     *
     * @throws NullPointerException if {@code orientations} is {@code null}
     */
    public Compass(@NonNull CarValue<List<Float>> orientations) {
        mOrientations = requireNonNull(orientations);
    }

    /** Constructs an empty instance, used by serialization code. */
    private Compass() {
        mOrientations = CarValue.UNKNOWN_FLOAT_LIST;
    }
}