jhomenet.hw.sensor
Class RainSensor

java.lang.Object
  Model
      jhomenet.hw.HomenetHardware
          jhomenet.hw.sensor.Sensor
              jhomenet.hw.sensor.ValueSensor
                  jhomenet.hw.sensor.RainSensor

All Implemented Interfaces:

java.io.Serializable, Hardware

public class RainSensor
extends ValueSensor

Id: $Id: RainSensor.java,v 1.5 2005/10/28 01:20:19 dhirwinjr Exp $

Author:

David Irwin

Field Summary

Fields inherited from class jhomenet.hw.sensor.Sensor

currentData, INVALID_DATA, maxData, minData, pollingType, PROPERTYNAME_CURRENTDATA, PROPERTYNAME_MAXDATA, PROPERTYNAME_MINDATA, PROPERTYNAME_POLLINGTYPE, readFailed

Fields inherited from class jhomenet.hw.HomenetHardware

configuration, driver, errorTracker, hardwareDescription, hardwareId, PROPERTYNAME_CONFIGURATION, PROPERTYNAME_SETUPDESC, setupDescription

Constructor Summary

RainSensor()
Constructor.

RainSensor(java.lang.String hardwareID, java.lang.String description)
Default constructor.

Method Summary

protected void	initializeHardwareDescription() Set the hardware description.
protected double	readFromDriver() Read the raw value from the driver.
HardwareData	readSensor() Capture the sensor's data in the sensor's current unit (if applicable).

Methods inherited from class jhomenet.hw.sensor.Sensor

capture, getCurrentAsString, getCurrentData, getMaxData, getMinData, getPollingType, getPollingTypeListModel, isFirstPoll, resetData, setCurrentData, setMaxData, setMinData, setPollingType, toString

Methods inherited from class jhomenet.hw.HomenetHardware

equals, getConfiguration, getConfiguration, getDriverHardwareDescription, getDriverName, getErrorCount, getHardwareClassname, getHardwareDescription, getHardwareId, getSetupDescription, initializeHardware, isRegistered, setConfiguration, setConfiguration, setDriver, setHardwareId, setSetupDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

RainSensor

public RainSensor(java.lang.String hardwareID,
                  java.lang.String description)

Default constructor.

Parameters:

hardwareID -

description -

RainSensor

public RainSensor()

Constructor.

Method Detail

initializeHardwareDescription

protected void initializeHardwareDescription()

Description copied from class: HomenetHardware

Set the hardware description.

Specified by:

initializeHardwareDescription in class HomenetHardware

See Also:

HomenetHardware.initializeHardwareDescription()

readSensor

public HardwareData readSensor()
                        throws SensorException

Description copied from class: Sensor

Capture the sensor's data in the sensor's current unit (if applicable).

Specified by:

readSensor in class Sensor

Returns:

The sensor's data in the sensor's default data unit.

Throws:

SensorException

See Also:

Sensor.readSensor()

readFromDriver

protected double readFromDriver()
                         throws SensorException

Description copied from class: Sensor

Read the raw value from the driver.

Specified by:

readFromDriver in class Sensor

Returns:

The raw value read from the driver.

Throws:

SensorException

See Also:

Sensor.readFromDriver()