com.pi4j.device.fireplace.impl

Class FireplaceDevice

java.lang.Object

com.pi4j.device.DeviceBase

com.pi4j.device.ObserveableDeviceBase

com.pi4j.device.fireplace.FireplaceBase

com.pi4j.device.fireplace.impl.FireplaceDevice

All Implemented Interfaces:

Device, Fireplace, ObserveableDevice

public class FireplaceDevice
extends FireplaceBase

Field Summary

Fields

Modifier and Type	Field and Description
protected Relay	fireplaceControlRelay
protected RelayState	fireplaceOnRelayState
protected SensorState	pilotLightOnState
protected Sensor	pilotLightSensor

Fields inherited from class com.pi4j.device.fireplace.FireplaceBase

executor, timeoutDelay, timeoutTask, timeoutUnit

Fields inherited from class com.pi4j.device.ObserveableDeviceBase

listeners

Constructor Summary

Constructors

Constructor and Description
FireplaceDevice(Relay fireplaceControlRelay)
FireplaceDevice(Relay fireplaceControlRelay, RelayState fireplaceOnRelayState)
FireplaceDevice(Relay fireplaceControlRelay, RelayState fireplaceOnRelayState, Sensor pilotLightSensor, SensorState pilotLightOnState)
FireplaceDevice(Relay fireplaceControlRelay, Sensor pilotLightSensor)

Method Summary

Modifier and Type	Method and Description
FireplaceState	getState()
boolean	isPilotLightOff()
boolean	isPilotLightOn()
void	setState(FireplaceState state)

Methods inherited from class com.pi4j.device.fireplace.FireplaceBase

addListener, addListener, addListener, cancelTimeout, cancelTimeoutTask, getTimeoutDelay, getTimeoutUnit, isOff, isOn, isState, notifyListeners, notifyListeners, notifyListeners, off, on, on, removeListener, removeListener, removeListener, setTimeout, shutdown

Methods inherited from class com.pi4j.device.ObserveableDeviceBase

addListener, removeAllListeners, removeListener

Methods inherited from class com.pi4j.device.DeviceBase

clearProperties, getName, getProperties, getProperty, getProperty, getTag, hasProperty, removeProperty, setName, setProperty, setTag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.pi4j.device.ObserveableDevice

removeAllListeners

Methods inherited from interface com.pi4j.device.Device

clearProperties, getName, getProperties, getProperty, getProperty, getTag, hasProperty, removeProperty, setName, setProperty, setTag

Field Detail

fireplaceControlRelay

protected final Relay fireplaceControlRelay

fireplaceOnRelayState

protected final RelayState fireplaceOnRelayState

pilotLightSensor

protected final Sensor pilotLightSensor

pilotLightOnState

protected final SensorState pilotLightOnState

Constructor Detail

FireplaceDevice

public FireplaceDevice(Relay fireplaceControlRelay,
                       Sensor pilotLightSensor)

FireplaceDevice

public FireplaceDevice(Relay fireplaceControlRelay,
                       RelayState fireplaceOnRelayState)

FireplaceDevice

public FireplaceDevice(Relay fireplaceControlRelay)

FireplaceDevice

public FireplaceDevice(Relay fireplaceControlRelay,
                       RelayState fireplaceOnRelayState,
                       Sensor pilotLightSensor,
                       SensorState pilotLightOnState)

Method Detail

getState

public FireplaceState getState()

Specified by:

getState in interface Fireplace

Specified by:

getState in class FireplaceBase

setState

public void setState(FireplaceState state)
              throws FireplacePilotLightException

Throws:

FireplacePilotLightException

isPilotLightOn

public boolean isPilotLightOn()

isPilotLightOff

public boolean isPilotLightOff()