Model (DTE Documentation)

java.lang.Object
- java.util.Observable
- - be.chrisv.dte.model.Model

public class Model
extends java.util.Observable

Model of the App, contain all the data

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALERT_COOLING` The Cooling Alert Level : 0
`static int`	`ALERT_HEATING` The HEATING AlertLevel : 2
`static int`	`ALERT_IDLE` The IDLE Alert Level : 1
`static int`	`ALERT_OVERHEATING` The OVERHEATING (When the temperature is over the threshold) AlertLevel: 3
`static java.lang.String`	`APPNAME` The name of the app
`static int`	`BAUDRATE` The communication baudrate
`static int`	`MAX_ALERT_LVL` Represent the biggest alertLevel : 3
`static int`	`MIN_ALERT_LVL` Represent the smallest alertLevel : 0

Constructor Summary

Constructors
Constructor and Description
`Model()` Empty Model constructor.
`Model(int currentTemperature, int thresholdTemperature)` Model constructor with current and threshold temperature.
`Model(int currentTemperature, int thresholdTemperature, int alertLevel)` Full Model constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAlertLevelToHistory(java.util.Date date, int alertLevel)` Add a record of alertLevel to the history at the current date
`void`	`addAlertLevelToHistory(int alertLevel)` Add a record of alertLevel to the history at the current date
`void`	`addTemperatureToHistory(java.util.Date date, int temperature)` Add a temperature at the given date to the temperature history
`void`	`addTemperatureToHistory(int currentTemperature)` Add a temperature to the temperature history
`void`	`checkAlertLevel()` Check and update the alertlevel by comparing the currentTemperature and the current threshold temparature
`int`	`getAlertLevel()` Get the current AlertLevel
`int`	`getAlertLevelFromHistory(java.util.Date date)` getAlertLevelFromHistory return the AlertLevel at a date
`java.util.LinkedHashMap<java.util.Date,java.lang.Integer>`	`getAlertLevelHistory()` Get the alert level history
`int`	`getCurrentTemperature()` Get the currentTemperature
`java.io.InputStream`	`getDownlink()` Get the downlink
`java.util.Enumeration`	`getEnumCOMPort()` Get the list of avaliable COM ports
`gnu.io.CommPortIdentifier`	`getSerialPortId()` Get the identifier of the connected COM port
`int`	`getTemperatureFromHistory(java.util.Date date)` Get the temperature at a given date
`java.util.LinkedHashMap<java.util.Date,java.lang.Integer>`	`getTemperaturesHistory()` Get the temperature history
`int`	`getThresholdTemperature()` Get the threshold temperature (Temperature when the alert will be triggered)
`java.io.OutputStream`	`getUplink()` Get the uplink
`java.io.PrintWriter`	`getUplinkWriter()` Get the uplinkWriter
`boolean`	`isAlertLevelCorrect(int alertLevel)` Check if the given alertLevel is correct
`boolean`	`isConnected()` Check the connection
`void`	`setAlertLevel(int alertLevel)` Set the alertLevel and record it on the AlertLevelHistory HashMap
`void`	`setConnected(boolean connected)` Set the connection status
`void`	`setCurrentTemperature(int currentTemperature)` Set the currentTemperature and record it on the temperaturesHistory's HashMap
`void`	`setDownlink(java.io.InputStream downlink)` Set the downlink
`void`	`setEnumCOMPort(java.util.Enumeration enumCOMPort)` Set the list of avaliable COM ports
`void`	`setSerialPortId(gnu.io.CommPortIdentifier serialPortId)` Set the identifier of the connected COM port
`void`	`setThresholdTemperature(int thresholdTemperature)` Set the threshold temperature (Temperature when the alert will be triggered)
`void`	`setUplink(java.io.OutputStream uplink)` Set the uplink
`void`	`setUplinkWriter(java.io.PrintWriter uplinkWriter)` Set the uplinkWriter
`java.lang.String`	`toString()`

Methods inherited from class java.util.Observable
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - APPNAME
```
public static final java.lang.String APPNAME
```
    The name of the app
    
    See Also:
    
    Constant Field Values
  - BAUDRATE
```
public static final int BAUDRATE
```
    The communication baudrate
    
    See Also:
    
    Constant Field Values
  - MIN_ALERT_LVL
```
public static final int MIN_ALERT_LVL
```
    Represent the smallest alertLevel : 0
    
    See Also:
    
    Constant Field Values
  - MAX_ALERT_LVL
```
public static final int MAX_ALERT_LVL
```
    Represent the biggest alertLevel : 3
    
    See Also:
    
    Constant Field Values
  - ALERT_COOLING
```
public static final int ALERT_COOLING
```
    The Cooling Alert Level : 0
    
    See Also:
    
    Constant Field Values
  - ALERT_IDLE
```
public static final int ALERT_IDLE
```
    The IDLE Alert Level : 1
    
    See Also:
    
    Constant Field Values
  - ALERT_HEATING
```
public static final int ALERT_HEATING
```
    The HEATING AlertLevel : 2
    
    See Also:
    
    Constant Field Values
  - ALERT_OVERHEATING
```
public static final int ALERT_OVERHEATING
```
    The OVERHEATING (When the temperature is over the threshold) AlertLevel: 3
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Model
```
public Model()
```
    Empty Model constructor. Initialize the history and set all the instance variables to -1000 (Default state).
  - Model
```
public Model(int currentTemperature,
             int thresholdTemperature,
             int alertLevel)
      throws UnknowAlertLevelException
```
    Full Model constructor
    
    Parameters:
    
    currentTemperature - Must be an int and be the current temperature given by the sensors
    
    thresholdTemperature - Must be an int and be the temperature who trigger the alert
    
    alertLevel - int Must be greater than 0 and smaller than 3
    
    Throws:
    
    UnknowAlertLevelException - When the alertLevel parametter is strictly smaller than 0 or stritly bigger than 3
  - Model
```
public Model(int currentTemperature,
             int thresholdTemperature)
```
    Model constructor with current and threshold temperature. Automaticaly calculate the AlertLevel
    
    Parameters:
    
    currentTemperature - Must be an int and be the current temperature given by the sensors
    
    thresholdTemperature - Must be an int and be the temperature who trigger the alert
- Method Detail
  - getUplinkWriter
```
public java.io.PrintWriter getUplinkWriter()
```
    Get the uplinkWriter
    
    Returns:
    
    PrintWriter The uplinkWriter
  - setUplinkWriter
```
public void setUplinkWriter(java.io.PrintWriter uplinkWriter)
```
    Set the uplinkWriter
    
    Parameters:
    
    uplinkWriter - PrintWriter
  - getUplink
```
public java.io.OutputStream getUplink()
```
    Get the uplink
    
    Returns:
    
    OutputStream upLink
  - setUplink
```
public void setUplink(java.io.OutputStream uplink)
```
    Set the uplink
    
    Parameters:
    
    uplink - OutputStream
  - getDownlink
```
public java.io.InputStream getDownlink()
```
    Get the downlink
    
    Returns:
    
    downlink InputStream
  - setDownlink
```
public void setDownlink(java.io.InputStream downlink)
```
    Set the downlink
    
    Parameters:
    
    downlink - InputStream
  - isConnected
```
public boolean isConnected()
```
    Check the connection
    
    Returns:
    
    true if the model is connected to a COM port, false otherwise.
  - setConnected
```
public void setConnected(boolean connected)
```
    Set the connection status
    
    Parameters:
    
    connected - boolean
  - getSerialPortId
```
public gnu.io.CommPortIdentifier getSerialPortId()
```
    Get the identifier of the connected COM port
    
    Returns:
    
    CommPortIdentifier Connected SerialPortID
  - setSerialPortId
```
public void setSerialPortId(gnu.io.CommPortIdentifier serialPortId)
```
    Set the identifier of the connected COM port
    
    Parameters:
    
    serialPortId - ComPortIdentifier the id of the connected COM port
  - getEnumCOMPort
```
public java.util.Enumeration getEnumCOMPort()
```
    Get the list of avaliable COM ports
    
    Returns:
    
    Enumeration List of avaliable COM ports
  - setEnumCOMPort
```
public void setEnumCOMPort(java.util.Enumeration enumCOMPort)
```
    Set the list of avaliable COM ports
    
    Parameters:
    
    enumCOMPort - Enumeration List of avaliable COM ports
  - getCurrentTemperature
```
public int getCurrentTemperature()
```
    Get the currentTemperature
    
    Returns:
    
    int currentTemperature
  - setCurrentTemperature
```
public void setCurrentTemperature(int currentTemperature)
```
    Set the currentTemperature and record it on the temperaturesHistory's HashMap
    
    Parameters:
    
    currentTemperature - int The current temperature
  - getThresholdTemperature
```
public int getThresholdTemperature()
```
    Get the threshold temperature (Temperature when the alert will be triggered)
    
    Returns:
    
    int The threshold temperature (Temperature when the alert will be triggered)
  - setThresholdTemperature
```
public void setThresholdTemperature(int thresholdTemperature)
```
    Set the threshold temperature (Temperature when the alert will be triggered)
    
    Parameters:
    
    thresholdTemperature - int The threshold temperature (Temperature when the alert will be triggered)
  - checkAlertLevel
```
public void checkAlertLevel()
```
    Check and update the alertlevel by comparing the currentTemperature and the current threshold temparature
  - getAlertLevel
```
public int getAlertLevel()
```
    Get the current AlertLevel
    
    Returns:
    
    int greater than 0 and smaller than 3 {0, 1, 2, 3}
  - setAlertLevel
```
public void setAlertLevel(int alertLevel)
                   throws UnknowAlertLevelException
```
    Set the alertLevel and record it on the AlertLevelHistory HashMap
    
    Parameters:
    
    alertLevel - int int Must be greater than 0 and smaller than 3 {0, 1, 2, 3}
    
    Throws:
    
    UnknowAlertLevelException - When the parametter is strictly smaller than 0 and stritly bigger than 3
  - getAlertLevelHistory
```
public java.util.LinkedHashMap<java.util.Date,java.lang.Integer> getAlertLevelHistory()
                                                                               throws EmptyHistoryException
```
    Get the alert level history
    
    Returns:
    
    HashMap(Date, Integer) AlertLevel history
    
    Throws:
    
    EmptyHistoryException - when there is no AlertLevel recorded yet.
  - addAlertLevelToHistory
```
public final void addAlertLevelToHistory(int alertLevel)
                                  throws UnknowAlertLevelException
```
    Add a record of alertLevel to the history at the current date
    
    Parameters:
    
    alertLevel - int int Must be greater than 0 and smaller than 3 {0, 1, 2, 3}
    
    Throws:
    
    UnknowAlertLevelException - When the parametter is strictly smaller than 0 and stritly bigger than 3
  - addAlertLevelToHistory
```
public final void addAlertLevelToHistory(java.util.Date date,
                                         int alertLevel)
                                  throws UnknowAlertLevelException
```
    Add a record of alertLevel to the history at the current date
    
    Parameters:
    
    date - Date when the alertLevel was set
    
    alertLevel - int Must be greater than 0 and smaller than 3 {0, 1, 2, 3}
    
    Throws:
    
    UnknowAlertLevelException - When the parametter is strictly smaller than 0 and stritly bigger than 3
  - getAlertLevelFromHistory
```
public int getAlertLevelFromHistory(java.util.Date date)
                             throws NoHistoryDataAvaliableException
```
    getAlertLevelFromHistory return the AlertLevel at a date
    
    Parameters:
    
    date - Date Must be in the past
    
    Returns:
    
    int The AlertLevel at the given date
    
    Throws:
    
    NoHistoryDataAvaliableException - when there is no entry at the given date
  - getTemperaturesHistory
```
public java.util.LinkedHashMap<java.util.Date,java.lang.Integer> getTemperaturesHistory()
                                                                                 throws EmptyHistoryException
```
    Get the temperature history
    
    Returns:
    
    HashMap(date, Integer) temperatureHistory
    
    Throws:
    
    EmptyHistoryException - when there is no temperature recorded yet
  - getTemperatureFromHistory
```
public int getTemperatureFromHistory(java.util.Date date)
                              throws NoHistoryDataAvaliableException
```
    Get the temperature at a given date
    
    Parameters:
    
    date - Must be a date in the past
    
    Returns:
    
    int The temperature at the given date
    
    Throws:
    
    NoHistoryDataAvaliableException - when there is no temperature recorded at the given date
  - addTemperatureToHistory
```
public final void addTemperatureToHistory(int currentTemperature)
```
    Add a temperature to the temperature history
    
    Parameters:
    
    currentTemperature - int The currentTemperature
  - addTemperatureToHistory
```
public void addTemperatureToHistory(java.util.Date date,
                                    int temperature)
```
    Add a temperature at the given date to the temperature history
    
    Parameters:
    
    date - Date when the temperature was set
    
    temperature - The Temperature at the date
  - isAlertLevelCorrect
```
public boolean isAlertLevelCorrect(int alertLevel)
```
    Check if the given alertLevel is correct
    
    Parameters:
    
    alertLevel - int Must be greater than 0 and smaller than 3 {0, 1, 2, 3}
    
    Returns:
    
    true if the given alertLevel is correct; False otherwise.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Model

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Field Detail

APPNAME

BAUDRATE

MIN_ALERT_LVL

MAX_ALERT_LVL

ALERT_COOLING

ALERT_IDLE

ALERT_HEATING

ALERT_OVERHEATING

Constructor Detail

Model

Model

Model

Method Detail

getUplinkWriter

setUplinkWriter

getUplink

setUplink

getDownlink

setDownlink

isConnected

setConnected

getSerialPortId

setSerialPortId

getEnumCOMPort

setEnumCOMPort

getCurrentTemperature

setCurrentTemperature

getThresholdTemperature

setThresholdTemperature

checkAlertLevel

getAlertLevel

setAlertLevel

getAlertLevelHistory

addAlertLevelToHistory

addAlertLevelToHistory

getAlertLevelFromHistory

getTemperaturesHistory

getTemperatureFromHistory

addTemperatureToHistory

addTemperatureToHistory

isAlertLevelCorrect

toString