automotive/vehicle/aidl/android/hardware/automotive/vehicle/VehiclePropValue.aidl

/*
 * Copyright (C) 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 android.hardware.automotive.vehicle;

import android.hardware.automotive.vehicle.RawPropValues;
import android.hardware.automotive.vehicle.VehiclePropertyStatus;

/**
 * Encapsulates the property name and the associated value. It
 * is used across various API calls to set values, get values or to register for
 * events.
 */
@VintfStability
@JavaDerive(equals=true, toString=true)
@RustDerive(Clone=true)
parcelable VehiclePropValue {
    /** Time is elapsed nanoseconds since boot */
    long timestamp;

    /**
     * Area type(s) for non-global property it must be one of the value from
     * VehicleArea* enums or 0 for global properties.
     */
    int areaId;

    /** Property identifier */
    int prop;

    /**
     * Status of the property for reading.
     *
     * For read/write property, this may also apply for writing but not
     * guaranteed, e.g. the property might be available for read but not
     * available for writing. In such case, status is AVAILABLE and the value
     * field contains valid information.
     *
     * NOTE: There is currently no way for a client to monitor the write status for a read/write or
     * write property. The client only knows if the property is available for writing when it tries
     * to set the value (via the StatusCode).
     *
     * NOTE: If the status is not AVAILABLE, the value field must be ignored.
     */
    VehiclePropertyStatus status = VehiclePropertyStatus.AVAILABLE;

    RawPropValues value;
}