main

Class Controller

java.lang.Object

main.Controller

public class Controller
extends java.lang.Object

Enable management of a range of controlled devices. Functionality: - Add remove a device to/from the list of devices to be controlled. - Send a new input reading to a controlled device.

Version:

1.0 : May 08th, 2015

Author:

Diana Kirk

Constructor Summary

Constructors

Constructor and Description
Controller()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addDevice(main.ControlDeviceType deviceType, java.lang.String deviceID, int operatingMin, int operatingMax, int safeMin, int safeMax) Add a device to the list of devices to be controlled by this controller.
boolean	doControl(java.lang.String deviceID, int inputVal) Activate control of a device by sending it a new input value.
int	getNumDevices()
boolean	isDeviceInList(java.lang.String deviceID)
boolean	removeDevice(java.lang.String deviceID) Remove a device from the list of devices to be controlled by this controller.

Methods inherited from class java.lang.Object

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

Constructor Detail

Controller

public Controller()

Method Detail

addDevice

public boolean addDevice(main.ControlDeviceType deviceType,
                java.lang.String deviceID,
                int operatingMin,
                int operatingMax,
                int safeMin,
                int safeMax)
                  throws java.lang.IllegalArgumentException,
                         java.lang.NullPointerException

Add a device to the list of devices to be controlled by this controller. A controller can control up to six physical devices. The method succeeds if the device is successfully added to the list of controlled devices. The method fails if the list is full or if the device is not correctly specified.

Parameters:

deviceType - The type of device to be controlled (enumerated in 'ControlledDeviceTypes')

deviceID - Unique identifier for the physical device. This is a 4-digit string.

operatingMin - Minimum value accepted by the device i.e. operating range floor. Non-negative integer value expected.

operatingMax - Maximum value accepted by the device i.e. operating range ceiling. Non-negative integer value expected.

safeMin - Minimum 'safe' operating value for the device. Expected >= 'operatingMin'.

safeMax - Maximum 'safe' operating value accepted by the device. Expected <= operatingMax'.

Returns:

'true' if the device is successfully added to the list 'false' already 6 devices in the array OR 'deviceID' has fewer or more than 4 characters OR 'deviceID' contains non-numeric characters OR a device with this deviceID has already been included in the list OR safe range is not within operating range.

Throws:

java.lang.IllegalArgumentException - if 'deviceID' is invalid or is already in the list

java.lang.NullPointerException - if 'deviceID' is null

java.lang.IllegalArgumentException - if 'operatingMin' or 'operatingMax' is negative

java.lang.IllegalArgumentException - if 'operatingMin' is greater than 'operatingMax'

java.lang.IllegalArgumentException - if 'safeMin' is greater than 'safeMax'

java.lang.IllegalArgumentException - if 'safeMin' or 'safeMax' are outside 'operatingMin' and 'operatingMax'

removeDevice

public boolean removeDevice(java.lang.String deviceID)
                     throws java.lang.NullPointerException

Remove a device from the list of devices to be controlled by this controller. The method succeeds if the device is successfully removed from the list of controlled devices. The method fails if the list is empty, the device is not in the list or "deviceID" is null.

Parameters:

deviceID - Unique identifier for the physical device. This is a 4-digit string.

Returns:

'true' if the device is successfully removed from the list 'false' if the device is not in the list OR the list is empty

Throws:

java.lang.NullPointerException - if "deviceID" is null

doControl

public boolean doControl(java.lang.String deviceID,
                int inputVal)

Activate control of a device by sending it a new input value. The method succeeds if the device is successfully controlled. The method fails if the device is not in the list, "deviceID" is null, the input value is not within the operating range of the device or the control call fails.

Parameters:

deviceID - Unique identifier for the physical device. This is a 4-digit string.

inputVal - The value to be passed to the device.

Returns:

'true' if the device successfully activates control 'false' if 'deviceId' is not in the list OR 'deviceID' is null OR 'inputVal' is not inside the operating range for 'deviceID' OR control call fails

isDeviceInList

public boolean isDeviceInList(java.lang.String deviceID)

getNumDevices

public int getNumDevices()