version2/src/java/light_fan_embed_fake_benchmark/LightBulb.java

   1 /** Class LightBulb interface for the light bulb devices.
   2  *
   3  * @author      Ali Younis <ayounis @ uci.edu>
   4  * @version     1.0
   5  * @since       2016-01-27
   6  */
   7
   8
   9 public class LightBulb {
  10
  11
  12         public LightBulb() {
  13
  14         }
  15
  16         /** Method to turn the light bulb on (Physically illuminate the area).
  17          *
  18          *   @param None.
  19          *
  20          *   @return [void] None.
  21          */
  22
  23         public void turnOff() {
  24                 System.out.println("Bulb Turning Off")
  25         }
  26
  27         /** Method to turn the light bulb off.
  28          *
  29          *   @return [void] None.
  30          */
  31         public void turnOn() {
  32                 System.out.println("Bulb Turning On")
  33         }
  34
  35
  36         /** Method to get the current on/off state of the light bulb.
  37          *
  38          *   @return [boolean] True means bulb on.
  39          */
  40         public boolean getState() {
  41                 return true;
  42         }
  43
  44
  45         /** Method to set the light bulb color using Standard Hue, Saturation and Brightness
  46          * conventions. See "http://www.tydac.ch/color/" for reference.
  47          *
  48          *   @param _hue [double]: Hue value (in degrees).
  49          *   @param _saturation [double]: Saturation value (percentage).
  50          *   @param _brightness [double]: Brightness value (percentage).
  51          *
  52          *   @return [void] None.
  53          */
  54         public void setColor(double _hue, double _saturation, double _brightness) {
  55
  56         }
  57
  58
  59         /** Method to set the color temperature.
  60          *
  61          *   @param _temperature [int]: Color temperature in degrees kelvin.
  62          *
  63          *   @return [void] None.
  64          */
  65         public void setTemperature(int _temperature) {
  66
  67         }
  68
  69
  70         /** Method to get the current hue value of the bulb.
  71          *
  72          *   @return [double] Current hue value of the bulb in degrees.
  73          */
  74         public double getHue() {
  75                 return 1;
  76         }
  77
  78
  79         /** Method to get the current saturation value of the bulb.
  80          *
  81          *   @return [double] Current saturation value of the bulb as a percentage.
  82          */
  83         public double getSaturation() {
  84                 return 1;
  85
  86         }
  87
  88
  89         /** Method to get the current brightness value of the bulb.
  90          *
  91          *   @return [double] Current brightness value of the bulb as a percentage.
  92          */
  93         public double getBrightness() {
  94                 return 1;
  95
  96         }
  97
  98
  99         /** Method to get the current color temperature value of the bulb.
 100          *
 101          *   @return [double] Current color temperature value of the bulb in kelvin.
 102          */
 103         public int getTemperature() {
 104                 return 1;
 105
 106         }
 107
 108
 109         /** Method to get the hue range lower bound supported by the bulb.
 110          *
 111          *   @return [double] Hue lower bound in degrees.
 112          */
 113         public double getHueRangeLowerBound() {
 114                 return 1;
 115
 116         }
 117
 118
 119         /** Method to get the hue range upper bound supported by the bulb.
 120          *
 121          *   @return [double] Hue upper bound in degrees.
 122          */
 123         public double getHueRangeUpperBound() {
 124                 return 1;
 125
 126         }
 127
 128
 129         /** Method to get the saturation range lower bound supported by the bulb.
 130          *
 131          *   @return [double] Saturation lower bound as a percentage.
 132          */
 133         public double getSaturationRangeLowerBound() {
 134                 return 1;
 135
 136         }
 137
 138
 139         /** Method to get the saturation range upper bound supported by the bulb.
 140          *
 141          *   @return [double] Saturation upper bound as a percentage.
 142          */
 143         public double getSaturationRangeUpperBound() {
 144                 return 1;
 145
 146         }
 147
 148
 149         /** Method to get the brightness range lower bound supported by the bulb.
 150          *
 151          *   @return [double] Brightness lower bound as a percentage.
 152          */
 153         public double getBrightnessRangeLowerBound() {
 154                 return 1;
 155
 156         }
 157
 158
 159         /** Method to get the brightness range upper bound supported by the bulb.
 160          *
 161          *   @return [double] Brightness upper bound as a percentage.
 162          */
 163         public double getBrightnessRangeUpperBound() {
 164                 return 1;
 165         }
 166
 167
 168         /** Method to get the temperature range lower bound supported by the bulb.
 169          *
 170          *   @return [int] Temperature lower bound as a percentage.
 171          */
 172         public int getTemperatureRangeLowerBound() {
 173                 return 1;
 174
 175         }
 176
 177
 178         /** Method to get the temperature range upper bound supported by the bulb.
 179          *
 180          *   @return [int] Temperature upper bound as a percentage.
 181          */
 182         public int getTemperatureRangeUpperBound() {
 183                 return 1;
 184
 185         }
 186
 187
 188         /** Method to initialize the bulb, if the bulb needs to be initialized.
 189          *
 190          *   @return [void] None.
 191          */
 192         public void init() {
 193
 194         }
 195
 196 }
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210