All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.smartdevicelink.proxy.rpc.RoofStatus Maven / Gradle / Ivy

/*
 * Copyright (c) 2017 - 2020, SmartDeviceLink Consortium, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the SmartDeviceLink Consortium Inc. nor the names of
 * its contributors may be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package com.smartdevicelink.proxy.rpc;

import androidx.annotation.NonNull;

import com.smartdevicelink.proxy.RPCStruct;
import com.smartdevicelink.proxy.rpc.enums.DoorStatusType;

import java.util.Hashtable;

/**
 * Describes the status of a parameter of roof/convertible roof/sunroof/moonroof etc. If roof
 * is open (AJAR), state will determine percentage of roof open.
 *
 * 

Parameter List

* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Param NameTypeDescriptionRequiredNotesVersion Available
locationGridY
statusDoorStatusTypeY
stateWindowStateN
* * @since SmartDeviceLink 7.1.0 */ public class RoofStatus extends RPCStruct { public static final String KEY_LOCATION = "location"; public static final String KEY_STATUS = "status"; public static final String KEY_STATE = "state"; /** * Constructs a new RoofStatus object */ public RoofStatus() { } /** * Constructs a new RoofStatus object indicated by the Hashtable parameter * * @param hash The Hashtable to use */ public RoofStatus(Hashtable hash) { super(hash); } /** * Constructs a new RoofStatus object * * @param location * @param status */ public RoofStatus(@NonNull Grid location, @NonNull DoorStatusType status) { this(); setLocation(location); setStatus(status); } /** * Sets the location. * * @param location */ public RoofStatus setLocation(@NonNull Grid location) { setValue(KEY_LOCATION, location); return this; } /** * Gets the location. * * @return Grid */ public Grid getLocation() { return (Grid) getObject(Grid.class, KEY_LOCATION); } /** * Sets the status. * * @param status */ public RoofStatus setStatus(@NonNull DoorStatusType status) { setValue(KEY_STATUS, status); return this; } /** * Gets the status. * * @return DoorStatusType */ public DoorStatusType getStatus() { return (DoorStatusType) getObject(DoorStatusType.class, KEY_STATUS); } /** * Sets the state. * * @param state */ public RoofStatus setState(WindowState state) { setValue(KEY_STATE, state); return this; } /** * Gets the state. * * @return WindowState */ public WindowState getState() { return (WindowState) getObject(WindowState.class, KEY_STATE); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy