com.smartdevicelink.proxy.rpc

Class ClimateControlCapabilities

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.ClimateControlCapabilities

All Implemented Interfaces:

Cloneable

public class ClimateControlCapabilities
extends RPCStruct

Contains information about a climate control module's capabilities.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_AC_ENABLE_AVAILABLE
static String	KEY_AC_MAX_ENABLE_AVAILABLE
static String	KEY_AUTO_MODE_ENABLE_AVAILABLE
static String	KEY_CIRCULATE_AIR_ENABLE_AVAILABLE
static String	KEY_CLIMATE_ENABLE_AVAILABLE
static String	KEY_CURRENT_TEMPERATURE_AVAILABLE
static String	KEY_DEFROST_ZONE
static String	KEY_DEFROST_ZONE_AVAILABLE
static String	KEY_DESIRED_TEMPERATURE_AVAILABLE
static String	KEY_DUAL_MODE_ENABLE_AVAILABLE
static String	KEY_FAN_SPEED_AVAILABLE
static String	KEY_HEATED_MIRRORS_AVAILABLE
static String	KEY_HEATED_REAR_WINDOW_AVAILABLE
static String	KEY_HEATED_STEERING_WHEEL_AVAILABLE
static String	KEY_HEATED_WIND_SHIELD_AVAILABLE
static String	KEY_MODULE_INFO
static String	KEY_MODULE_NAME
static String	KEY_VENTILATION_MODE
static String	KEY_VENTILATION_MODE_AVAILABLE

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
ClimateControlCapabilities()
ClimateControlCapabilities(Hashtable<String,Object> hash)
ClimateControlCapabilities(String moduleName) Constructs a newly allocated ClimateControlCapabilities

Method Summary

Modifier and Type	Method and Description
Boolean	getAcEnableAvailable() Gets the acEnableAvailable portion of the ClimateControlCapabilities class
Boolean	getAcMaxEnableAvailable() Gets the acMaxEnableAvailable portion of the ClimateControlCapabilities class
Boolean	getAutoModeEnableAvailable() Gets the autoModeEnableAvailable portion of the ClimateControlCapabilities class
Boolean	getCirculateAirEnableAvailable() Gets the circulateAirEnableAvailable portion of the ClimateControlCapabilities class
Boolean	getClimateEnableAvailable() Gets the climateEnableAvailable portion of the ClimateControlCapabilities class
Boolean	getCurrentTemperatureAvailable() Gets the currentTemperatureAvailable portion of the ClimateControlCapabilities class
List<DefrostZone>	getDefrostZone() Gets the List portion of the ClimateControlCapabilities class
Boolean	getDefrostZoneAvailable() Gets the defrostZoneAvailable portion of the ClimateControlCapabilities class
Boolean	getDesiredTemperatureAvailable() Gets the desiredTemperatureAvailable portion of the ClimateControlCapabilities class
Boolean	getDualModeEnableAvailable() Gets the dualModeEnableAvailable portion of the ClimateControlCapabilities class
Boolean	getFanSpeedAvailable() Gets the fanSpeedAvailable portion of the ClimateControlCapabilities class
Boolean	getHeatedMirrorsAvailable() Gets the heatedMirrorsAvailable portion of the ClimateControlCapabilities class
Boolean	getHeatedRearWindowAvailable() Gets the heatedRearWindowAvailable portion of the ClimateControlCapabilities class
Boolean	getHeatedSteeringWheelAvailable() Gets the heatedSteeringWheelAvailable portion of the ClimateControlCapabilities class
Boolean	getHeatedWindshieldAvailable() Gets the heatedWindshieldAvailable portion of the ClimateControlCapabilities class
ModuleInfo	getModuleInfo() Gets a ModuleInfo of this capability
String	getModuleName() Gets the moduleName portion of the ClimateControlCapabilities class
List<VentilationMode>	getVentilationMode() Gets the List portion of the ClimateControlCapabilities class
Boolean	getVentilationModeAvailable() Gets the ventilationModeAvailable portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setAcEnableAvailable(Boolean acEnableAvailable) Sets the acEnableAvailable portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setAcMaxEnableAvailable(Boolean acMaxEnableAvailable) Sets the acMaxEnableAvailable portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setAutoModeEnableAvailable(Boolean autoModeEnableAvailable) Sets the autoModeEnableAvailable portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setCirculateAirEnableAvailable(Boolean circulateAirEnableAvailable) Sets the circulateAirEnableAvailable portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setClimateEnableAvailable(Boolean climateEnableAvailable) Sets the climateEnableAvailable portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setCurrentTemperatureAvailable(Boolean currentTemperatureAvailable) Sets the currentTemperatureAvailable portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setDefrostZone(List<DefrostZone> defrostZone) Sets the defrostZone portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setDefrostZoneAvailable(Boolean defrostZoneAvailable) Sets the defrostZoneAvailable portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setDesiredTemperatureAvailable(Boolean desiredTemperatureAvailable) Sets the desiredTemperatureAvailable portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setDualModeEnableAvailable(Boolean dualModeEnableAvailable) Sets the dualModeEnableAvailable portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setFanSpeedAvailable(Boolean fanSpeedAvailable) Sets the fanSpeedAvailable portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setHeatedMirrorsAvailable(Boolean heatedMirrorsAvailable) Sets the heatedMirrorsAvailable portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setHeatedRearWindowAvailable(Boolean heatedRearWindowAvailable) Sets the heatedRearWindowAvailable portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setHeatedSteeringWheelAvailable(Boolean heatedSteeringWheelAvailable) Sets the heatedSteeringWheelAvailable portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setHeatedWindshieldAvailable(Boolean heatedWindshieldAvailable) Sets the heatedWindshieldAvailable portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setModuleInfo(ModuleInfo info) Sets ModuleInfo for this capability
ClimateControlCapabilities	setModuleName(String moduleName) Sets the moduleName portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setVentilationMode(List<VentilationMode> ventilationMode) Sets the ventilationMode portion of the ClimateControlCapabilities class
ClimateControlCapabilities	setVentilationModeAvailable(Boolean ventilationModeAvailable) Sets the ventilationModeAvailable portion of the ClimateControlCapabilities class

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_MODULE_NAME

public static final String KEY_MODULE_NAME

See Also:

Constant Field Values

KEY_FAN_SPEED_AVAILABLE

public static final String KEY_FAN_SPEED_AVAILABLE

See Also:

Constant Field Values

KEY_DESIRED_TEMPERATURE_AVAILABLE

public static final String KEY_DESIRED_TEMPERATURE_AVAILABLE

See Also:

Constant Field Values

KEY_CURRENT_TEMPERATURE_AVAILABLE

public static final String KEY_CURRENT_TEMPERATURE_AVAILABLE

See Also:

Constant Field Values

KEY_AC_ENABLE_AVAILABLE

public static final String KEY_AC_ENABLE_AVAILABLE

See Also:

Constant Field Values

KEY_AC_MAX_ENABLE_AVAILABLE

public static final String KEY_AC_MAX_ENABLE_AVAILABLE

See Also:

Constant Field Values

KEY_CIRCULATE_AIR_ENABLE_AVAILABLE

public static final String KEY_CIRCULATE_AIR_ENABLE_AVAILABLE

See Also:

Constant Field Values

KEY_AUTO_MODE_ENABLE_AVAILABLE

public static final String KEY_AUTO_MODE_ENABLE_AVAILABLE

See Also:

Constant Field Values

KEY_DUAL_MODE_ENABLE_AVAILABLE

public static final String KEY_DUAL_MODE_ENABLE_AVAILABLE

See Also:

Constant Field Values

KEY_DEFROST_ZONE_AVAILABLE

public static final String KEY_DEFROST_ZONE_AVAILABLE

See Also:

Constant Field Values

KEY_DEFROST_ZONE

public static final String KEY_DEFROST_ZONE

See Also:

Constant Field Values

KEY_VENTILATION_MODE_AVAILABLE

public static final String KEY_VENTILATION_MODE_AVAILABLE

See Also:

Constant Field Values

KEY_VENTILATION_MODE

public static final String KEY_VENTILATION_MODE

See Also:

Constant Field Values

KEY_HEATED_STEERING_WHEEL_AVAILABLE

public static final String KEY_HEATED_STEERING_WHEEL_AVAILABLE

See Also:

Constant Field Values

KEY_HEATED_WIND_SHIELD_AVAILABLE

public static final String KEY_HEATED_WIND_SHIELD_AVAILABLE

See Also:

Constant Field Values

KEY_HEATED_REAR_WINDOW_AVAILABLE

public static final String KEY_HEATED_REAR_WINDOW_AVAILABLE

See Also:

Constant Field Values

KEY_HEATED_MIRRORS_AVAILABLE

public static final String KEY_HEATED_MIRRORS_AVAILABLE

See Also:

Constant Field Values

KEY_MODULE_INFO

public static final String KEY_MODULE_INFO

See Also:

Constant Field Values

KEY_CLIMATE_ENABLE_AVAILABLE

public static final String KEY_CLIMATE_ENABLE_AVAILABLE

See Also:

Constant Field Values

Constructor Detail

ClimateControlCapabilities

public ClimateControlCapabilities()

ClimateControlCapabilities

public ClimateControlCapabilities(Hashtable<String,Object> hash)

ClimateControlCapabilities

public ClimateControlCapabilities(@NonNull
                                  String moduleName)

Constructs a newly allocated ClimateControlCapabilities

Parameters:

moduleName - The short friendly name of the climate control module. It should not be used to identify a module by mobile application.

Method Detail

setModuleName

public ClimateControlCapabilities setModuleName(@NonNull
                                                String moduleName)

Sets the moduleName portion of the ClimateControlCapabilities class

Parameters:

moduleName - The short friendly name of the climate control module. It should not be used to identify a module by mobile application.

getModuleName

public String getModuleName()

Gets the moduleName portion of the ClimateControlCapabilities class

Returns:

String - Short friendly name of the climate control module.

setFanSpeedAvailable

public ClimateControlCapabilities setFanSpeedAvailable(Boolean fanSpeedAvailable)

Sets the fanSpeedAvailable portion of the ClimateControlCapabilities class

Parameters:

fanSpeedAvailable - Availability of the control of fan speed. True: Available, False: Not Available, Not present: Not Available.

getFanSpeedAvailable

public Boolean getFanSpeedAvailable()

Gets the fanSpeedAvailable portion of the ClimateControlCapabilities class

Returns:

Boolean - Availability of the control of fan speed. True: Available, False: Not Available, Not present: Not Available.

setDesiredTemperatureAvailable

public ClimateControlCapabilities setDesiredTemperatureAvailable(Boolean desiredTemperatureAvailable)

Sets the desiredTemperatureAvailable portion of the ClimateControlCapabilities class

Parameters:

desiredTemperatureAvailable - Availability of the control of desired temperature. True: Available, False: Not Available, Not present: Not Available.

getDesiredTemperatureAvailable

public Boolean getDesiredTemperatureAvailable()

Gets the desiredTemperatureAvailable portion of the ClimateControlCapabilities class

Returns:

Boolean - Availability of the control of desired temperature. True: Available, False: Not Available, Not present: Not Available.

setCurrentTemperatureAvailable

public ClimateControlCapabilities setCurrentTemperatureAvailable(Boolean currentTemperatureAvailable)

Sets the currentTemperatureAvailable portion of the ClimateControlCapabilities class

Parameters:

currentTemperatureAvailable - Availability of the reading of current temperature. True: Available, False: Not Available, Not present: Not Available.

getCurrentTemperatureAvailable

public Boolean getCurrentTemperatureAvailable()

Gets the currentTemperatureAvailable portion of the ClimateControlCapabilities class

Returns:

Boolean - Availability of the reading of current temperature. True: Available, False: Not Available, Not present: Not Available.

setAcEnableAvailable

public ClimateControlCapabilities setAcEnableAvailable(Boolean acEnableAvailable)

Sets the acEnableAvailable portion of the ClimateControlCapabilities class

Parameters:

acEnableAvailable - Availability of the control of turn on/off AC. True: Available, False: Not Available, Not present: Not Available.

getAcEnableAvailable

public Boolean getAcEnableAvailable()

Gets the acEnableAvailable portion of the ClimateControlCapabilities class

Returns:

Boolean - Availability of the control of turn on/off AC. True: Available, False: Not Available, Not present: Not Available.

setAcMaxEnableAvailable

public ClimateControlCapabilities setAcMaxEnableAvailable(Boolean acMaxEnableAvailable)

Sets the acMaxEnableAvailable portion of the ClimateControlCapabilities class

Parameters:

acMaxEnableAvailable - Availability of the control of enable/disable air conditioning is ON on the maximum level. True: Available, False: Not Available, Not present: Not Available.

getAcMaxEnableAvailable

public Boolean getAcMaxEnableAvailable()

Gets the acMaxEnableAvailable portion of the ClimateControlCapabilities class

Returns:

Boolean - Availability of the control of enable/disable air conditioning is ON on the maximum level. True: Available, False: Not Available, Not present: Not Available.

setCirculateAirEnableAvailable

public ClimateControlCapabilities setCirculateAirEnableAvailable(Boolean circulateAirEnableAvailable)

Sets the circulateAirEnableAvailable portion of the ClimateControlCapabilities class

Parameters:

circulateAirEnableAvailable - Availability of the control of enable/disable circulate Air mode. True: Available, False: Not Available, Not present: Not Available.

getCirculateAirEnableAvailable

public Boolean getCirculateAirEnableAvailable()

Gets the circulateAirEnableAvailable portion of the ClimateControlCapabilities class

Returns:

Boolean - Availability of the control of enable/disable circulate Air mode. True: Available, False: Not Available, Not present: Not Available.

setAutoModeEnableAvailable

public ClimateControlCapabilities setAutoModeEnableAvailable(Boolean autoModeEnableAvailable)

Sets the autoModeEnableAvailable portion of the ClimateControlCapabilities class

Parameters:

autoModeEnableAvailable - Availability of the control of enable/disable auto mode. True: Available, False: Not Available, Not present: Not Available.

getAutoModeEnableAvailable

public Boolean getAutoModeEnableAvailable()

Gets the autoModeEnableAvailable portion of the ClimateControlCapabilities class

Returns:

Boolean - Availability of the control of enable/disable auto mode. True: Available, False: Not Available, Not present: Not Available.

setDualModeEnableAvailable

public ClimateControlCapabilities setDualModeEnableAvailable(Boolean dualModeEnableAvailable)

Sets the dualModeEnableAvailable portion of the ClimateControlCapabilities class

Parameters:

dualModeEnableAvailable - Availability of the control of enable/disable dual mode. True: Available, False: Not Available, Not present: Not Available.

getDualModeEnableAvailable

public Boolean getDualModeEnableAvailable()

Gets the dualModeEnableAvailable portion of the ClimateControlCapabilities class

Returns:

Boolean - Availability of the control of enable/disable dual mode. True: Available, False: Not Available, Not present: Not Available.

setDefrostZoneAvailable

public ClimateControlCapabilities setDefrostZoneAvailable(Boolean defrostZoneAvailable)

Sets the defrostZoneAvailable portion of the ClimateControlCapabilities class

Parameters:

defrostZoneAvailable - Availability of the control of defrost zones. True: Available, False: Not Available, Not present: Not Available.

getDefrostZoneAvailable

public Boolean getDefrostZoneAvailable()

Gets the defrostZoneAvailable portion of the ClimateControlCapabilities class

Returns:

Boolean - Availability of the control of defrost zones. True: Available, False: Not Available, Not present: Not Available.

getDefrostZone

public List<DefrostZone> getDefrostZone()

Gets the List portion of the ClimateControlCapabilities class

Returns:

List - A set of all defrost zones that are controllable.

setDefrostZone

public ClimateControlCapabilities setDefrostZone(List<DefrostZone> defrostZone)

Sets the defrostZone portion of the ClimateControlCapabilities class

Parameters:

defrostZone - A set of all defrost zones that are controllable.

setVentilationModeAvailable

public ClimateControlCapabilities setVentilationModeAvailable(Boolean ventilationModeAvailable)

Sets the ventilationModeAvailable portion of the ClimateControlCapabilities class

Parameters:

ventilationModeAvailable - Availability of the control of air ventilation mode. True: Available, False: Not Available, Not present: Not Available.

getVentilationModeAvailable

public Boolean getVentilationModeAvailable()

Gets the ventilationModeAvailable portion of the ClimateControlCapabilities class

Returns:

Boolean - Availability of the control of air ventilation mode. True: Available, False: Not Available, Not present: Not Available.

getVentilationMode

public List<VentilationMode> getVentilationMode()

Gets the List portion of the ClimateControlCapabilities class

Returns:

List - A set of all ventilation modes that are controllable.

setVentilationMode

public ClimateControlCapabilities setVentilationMode(List<VentilationMode> ventilationMode)

Sets the ventilationMode portion of the ClimateControlCapabilities class

Parameters:

ventilationMode - A set of all ventilation modes that are controllable.

setHeatedSteeringWheelAvailable

public ClimateControlCapabilities setHeatedSteeringWheelAvailable(Boolean heatedSteeringWheelAvailable)

Sets the heatedSteeringWheelAvailable portion of the ClimateControlCapabilities class

Parameters:

heatedSteeringWheelAvailable - Availability of the control (enable/disable) of heated Steering Wheel. True: Available, False: Not Available, Not present: Not Available.

getHeatedSteeringWheelAvailable

public Boolean getHeatedSteeringWheelAvailable()

Gets the heatedSteeringWheelAvailable portion of the ClimateControlCapabilities class

Returns:

Boolean - Availability of the control (enable/disable) of heated Steering Wheel. True: Available, False: Not Available, Not present: Not Available.

setHeatedWindshieldAvailable

public ClimateControlCapabilities setHeatedWindshieldAvailable(Boolean heatedWindshieldAvailable)

Sets the heatedWindshieldAvailable portion of the ClimateControlCapabilities class

Parameters:

heatedWindshieldAvailable - Availability of the control (enable/disable) of heated Windshield. True: Available, False: Not Available, Not present: Not Available.

getHeatedWindshieldAvailable

public Boolean getHeatedWindshieldAvailable()

Gets the heatedWindshieldAvailable portion of the ClimateControlCapabilities class

Returns:

Boolean - Availability of the control (enable/disable) of heated Windshield. True: Available, False: Not Available, Not present: Not Available.

setHeatedRearWindowAvailable

public ClimateControlCapabilities setHeatedRearWindowAvailable(Boolean heatedRearWindowAvailable)

Sets the heatedRearWindowAvailable portion of the ClimateControlCapabilities class

Parameters:

heatedRearWindowAvailable - Availability of the control (enable/disable) of heated Rear Window. True: Available, False: Not Available, Not present: Not Available.

getHeatedRearWindowAvailable

public Boolean getHeatedRearWindowAvailable()

Gets the heatedRearWindowAvailable portion of the ClimateControlCapabilities class

Returns:

Boolean - Availability of the control (enable/disable) of heated Rear Window. True: Available, False: Not Available, Not present: Not Available.

setHeatedMirrorsAvailable

public ClimateControlCapabilities setHeatedMirrorsAvailable(Boolean heatedMirrorsAvailable)

Sets the heatedMirrorsAvailable portion of the ClimateControlCapabilities class

Parameters:

heatedMirrorsAvailable - Availability of the control (enable/disable) of heated Mirrors. True: Available, False: Not Available, Not present: Not Available.

getHeatedMirrorsAvailable

public Boolean getHeatedMirrorsAvailable()

Gets the heatedMirrorsAvailable portion of the ClimateControlCapabilities class

Returns:

Boolean - Availability of the control (enable/disable) of heated Mirrors. True: Available, False: Not Available, Not present: Not Available.

setModuleInfo

public ClimateControlCapabilities setModuleInfo(ModuleInfo info)

Sets ModuleInfo for this capability

Parameters:

info - the ModuleInfo to be set

getModuleInfo

public ModuleInfo getModuleInfo()

Gets a ModuleInfo of this capability

Returns:

module info of this capability

setClimateEnableAvailable

public ClimateControlCapabilities setClimateEnableAvailable(Boolean climateEnableAvailable)

Sets the climateEnableAvailable portion of the ClimateControlCapabilities class

Parameters:

climateEnableAvailable - Availability of the control of enable/disable climate control. True: Available, False: Not Available, Not present: Not Available.

getClimateEnableAvailable

public Boolean getClimateEnableAvailable()

Gets the climateEnableAvailable portion of the ClimateControlCapabilities class

Returns:

Boolean - Availability of the control of enable/disable climate control. True: Available, False: Not Available, Not present: Not Available.