PEPPERSafetySystem

java.lang.Object
- com.eu.pepper.safetysystem.PEPPERSafetySystem

All Implemented Interfaces:: SafetySystem

public class PEPPERSafetySystem
extends java.lang.Object
implements SafetySystem

Facade for accessing the Safety System.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acceptCarbRecommendation(java.util.Date date)` Notifies the safety system that a carbohydrate recommendation has been accepted
`void`	`addCarbs(java.util.Date date, double carbs)` Registers a manual carbohydrate intake with the safety system.
`void`	`addInsulin(java.util.Date date, double insulin)` Registers a manual insulin administration with the safety system.
`void`	`addRecommendation(org.json.JSONObject caseJson)` Registers a finalised case with the safety system.
`void`	`clearDatabase()` Clears the database, this should be called after a successful JSON export.
`double`	`constrainBolus(org.json.JSONObject caseJson)` Returns the bolus and manipulates the case JSON.
`org.json.JSONObject`	`createJsonExport()` Creates and returns the Safety System JSON Object (SafetySystemResponse).
`void`	`declineCarbRecommendation(java.util.Date date)` Registers with the safety system that a carbohydrate recommendation has been declined.
`SafetyAlarmProfile`	`getAlarmProfile()` Returns the current alarm profile.
`double`	`getCarbRecommendation()` Returns the carbohydrate recommendation.
`java.lang.String`	`getCarbRecommendationAsString()` Returns the carbohydrate recommendation as a String.
`double`	`getCarbsOnBoard()` Returns the carbohydrates on board for the latest reading.
`java.lang.String`	`getCarbsOnBoardAsString()` Returns the carbohydrates on board for the latest reading as a String.
`SafetyCarerAlarm`	`getCarerAlarm()` Returns the carer alarm value for the latest reading.
`double`	`getCurrentICR()` Returns the users current ICR value for the current system time.
`double`	`getCurrentISF()` Returns the users current ISF value for the current system time.
`SafetyFault`	`getFault()` Determines whether there is a fault associated with the latest reading.
`SafetyGlucoseAlarm`	`getGlucoseAlarm()` Returns the glucose alarm value for the latest reading.
`SafetyGlucoseAlert`	`getGlucoseAlert()` Returns the glucose alert value for the latest reading.
`double`	`getGlucoseDerivative()` Returns the glucose derivative.
`double`	`getGlucoseForecast()` Returns the glucose forecast value for the latest reading.
`java.lang.String`	`getGlucoseForecastAsString()` Returns the glucose forecast value for the latest reading as a String.
`SafetyGlucoseTrend`	`getGlucoseTrend()` Returns the glucose trend.
`double`	`getHyperThreshold()` Gets the hyper threshold of the safety system.
`double`	`getHypoThreshold()` Gets the hypo threshold of the safety system.
`double`	`getInsulinOnBoard()` Returns the insulin on board for the latest reading.
`java.lang.String`	`getInsulinOnBoardAsString()` Returns the insulin on board for the latest reading as a String.
`SafetyLowGlucoseSuspend`	`getLowGlucoseSuspend()` Returns the glucose derivative value for the latest reading.
`java.lang.String`	`getPatientId()` Returns the patient's unique id.
`boolean`	`hasCarbRecommendation()` Returns true if there is a carbohydrate recommendation.
`boolean`	`hasCarerAlarm()` Returns true if there is a carer alarm.
`boolean`	`hasFault()` Returns true if there is a fault.
`boolean`	`hasGlucoseAlarm()` Returns true if there is a glucose alarm.
`boolean`	`hasGlucoseAlert()` Returns true if there is a glucose alert.
`boolean`	`initSafetySystem(org.json.JSONObject json)` Initialising the Safety System through a JSON object, the Safety System must be initialised prior to using the Safety System.
`boolean`	`isActive()` Returns true if the safety system is active.
`boolean`	`isCarerHyperAlarmEnabled()` Returns true if carer hyper alarms are enabled.
`boolean`	`isInitialised()` Returns true if the Safety System has been initialised, otherwise false.
`static boolean`	`isValidPatientObject(org.json.JSONObject patientObject)` Method for validating a patient object JSON.
`void`	`recalculateInsulin(double insulinAdministered)` Removes insulin from the Safety System Model for IoB correction when the pump is stopped
`void`	`resumePumpOverride()` Forces the pump to fully resume for 60 minutes.
`void`	`setActive(boolean active)` Set whether the safety system is active or not.
`void`	`setAlarmProfile(SafetyAlarmProfile profile)` Sets or updates the safety system alarm profile.
`void`	`setCarerHyperAlarmEnabled(boolean enabled)` Enables or disables carer hyper alarms.
`void`	`setHyperThreshold(double hyperThreshold)` Updates the hyper threshold of the safety system.
`void`	`setHypoThreshold(double hypoThreshold)` Updates the hypo threshold of the safety system.
`void`	`snoozeAlarm(java.util.Date date)` Snoozes the safety system alarms.
`void`	`update(java.util.Date date, double glucose)` Runs the main algorithms of the Safety System, returning a Reading with the computed values.

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

- Method Detail
  - isValidPatientObject
```
public static boolean isValidPatientObject(org.json.JSONObject patientObject)
```
    Method for validating a patient object JSON.
    
    Parameters:
    
    patientObject - the patient object JSON to check
    
    Returns:
    
    true if the JSON is valid, otherwise false
  - initSafetySystem
```
public boolean initSafetySystem(org.json.JSONObject json)
```
    Initialising the Safety System through a JSON object, the Safety System must be initialised prior to using the Safety System.
    
    Specified by:
    
    initSafetySystem in interface SafetySystem
    
    Parameters:
    
    json - the JSON to initialise the main Safety System object.
    
    Returns:
    
    true if the Safety System is initialized
  - isInitialised
```
public boolean isInitialised()
```
    Returns true if the Safety System has been initialised, otherwise false.
    
    Specified by:
    
    isInitialised in interface SafetySystem
    
    Returns:
    
    true if the Safety System has been initialised, otherwise false
  - isActive
```
public boolean isActive()
```
    Returns true if the safety system is active.
    
    Specified by:
    
    isActive in interface SafetySystem
    
    Returns:
    
    true if the safety system is active, otherwise false
  - setActive
```
public void setActive(boolean active)
```
    Set whether the safety system is active or not.
    
    Specified by:
    
    setActive in interface SafetySystem
  - update
```
public void update(java.util.Date date,
                   double glucose)
```
    Runs the main algorithms of the Safety System, returning a Reading with the computed values.
    
    Specified by:
    
    update in interface SafetySystem
    
    Parameters:
    
    date - the datetime at which the update occurred
    
    glucose - the latest CGM glucose reading
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - addRecommendation
```
public void addRecommendation(org.json.JSONObject caseJson)
                       throws org.json.JSONException,
                              java.text.ParseException
```
    Registers a finalised case with the safety system.
    
    Specified by:
    
    addRecommendation in interface SafetySystem
    
    Parameters:
    
    caseJson - the CBR JSON object after a case is complete
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
    
    org.json.JSONException - if the JSON is malformed
    
    java.text.ParseException - if there is an error parsing the JSON
  - addCarbs
```
public void addCarbs(java.util.Date date,
                     double carbs)
```
    Registers a manual carbohydrate intake with the safety system.
    This should be called whenever manual carbs are input.
    
    Specified by:
    
    addCarbs in interface SafetySystem
    
    Parameters:
    
    date - the datetime at which the update occurred
    
    carbs - the carbohydrate intake in grams
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - addInsulin
```
public void addInsulin(java.util.Date date,
                       double insulin)
```
    Registers a manual insulin administration with the safety system.
    This should be called whenever a manual bolus is input.
    
    Specified by:
    
    addInsulin in interface SafetySystem
    
    Parameters:
    
    date - the datetime at which the update occurred
    
    insulin - the insulin dose
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - snoozeAlarm
```
public void snoozeAlarm(java.util.Date date)
```
    Snoozes the safety system alarms.
    
    Specified by:
    
    snoozeAlarm in interface SafetySystem
    
    Parameters:
    
    date - the datetime at which the update occurred
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - acceptCarbRecommendation
```
public void acceptCarbRecommendation(java.util.Date date)
```
    Notifies the safety system that a carbohydrate recommendation has been accepted
    
    Specified by:
    
    acceptCarbRecommendation in interface SafetySystem
    
    Parameters:
    
    date - the datetime at which the update occurred
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - declineCarbRecommendation
```
public void declineCarbRecommendation(java.util.Date date)
```
    Registers with the safety system that a carbohydrate recommendation has been declined.
    
    Specified by:
    
    declineCarbRecommendation in interface SafetySystem
    
    Parameters:
    
    date - the datetime at which the update occurred
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - constrainBolus
```
public double constrainBolus(org.json.JSONObject caseJson)
                      throws org.json.JSONException,
                             java.text.ParseException
```
    Returns the bolus and manipulates the case JSON. If the CBR and Safety System are active, this method manipulates the case JSON to include the constrained bolus information and safety ICR/ISF in the JSON and returns the onstrained bolus. If the CBR is inactive and Safety active or the CBR and Safety System are inactive, this method will return the standard bolus calculation and popualte the case JSON with this information Otherwise if the CBR is active and Safety System is inactive this method will not perform any constraining.
    
    Specified by:
    
    constrainBolus in interface SafetySystem
    
    Parameters:
    
    caseJson - A JSON object containing a CBR case.
    
    Returns:
    
    the constrained bolus or standard calculation
    
    Throws:
    
    org.json.JSONException - if the JSON is malformed
    
    java.text.ParseException - if there is an error parsing the JSON
  - createJsonExport
```
public org.json.JSONObject createJsonExport()
                                     throws org.json.JSONException
```
    Creates and returns the Safety System JSON Object (SafetySystemResponse). After a successful export, the method clearDatabase() should be called.
    
    Specified by:
    
    createJsonExport in interface SafetySystem
    
    Returns:
    
    the Safety System JSON object.
    
    Throws:
    
    org.json.JSONException - if there is an error generating the JSON Object.
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getCarbsOnBoard
```
public double getCarbsOnBoard()
```
    Returns the carbohydrates on board for the latest reading.
    
    Specified by:
    
    getCarbsOnBoard in interface SafetySystem
    
    Returns:
    
    the carbohydrates on board or 0.0 if no reading is stored
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getCarbsOnBoardAsString
```
public java.lang.String getCarbsOnBoardAsString()
```
    Returns the carbohydrates on board for the latest reading as a String.
    
    Specified by:
    
    getCarbsOnBoardAsString in interface SafetySystem
    
    Returns:
    
    the carbohydrates on board or 0.0 as a String if no reading is stored
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getInsulinOnBoard
```
public double getInsulinOnBoard()
```
    Returns the insulin on board for the latest reading.
    
    Specified by:
    
    getInsulinOnBoard in interface SafetySystem
    
    Returns:
    
    the insulin on board or 0.0 if no reading is stored
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getInsulinOnBoardAsString
```
public java.lang.String getInsulinOnBoardAsString()
```
    Returns the insulin on board for the latest reading as a String.
    
    Specified by:
    
    getInsulinOnBoardAsString in interface SafetySystem
    
    Returns:
    
    the insulin on board or 0.0 as a String if no reading is stored
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getGlucoseForecast
```
public double getGlucoseForecast()
```
    Returns the glucose forecast value for the latest reading.
    
    Specified by:
    
    getGlucoseForecast in interface SafetySystem
    
    Returns:
    
    the glucose forecast value or 0.0 if no reading is stored
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getGlucoseForecastAsString
```
public java.lang.String getGlucoseForecastAsString()
```
    Returns the glucose forecast value for the latest reading as a String.
    
    Specified by:
    
    getGlucoseForecastAsString in interface SafetySystem
    
    Returns:
    
    the glucose forecast value or 0.0 as a String if no reading is stored
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getGlucoseTrend
```
public SafetyGlucoseTrend getGlucoseTrend()
```
    Returns the glucose trend.
    
    Specified by:
    
    getGlucoseTrend in interface SafetySystem
    
    Returns:
    
    the glucose trend
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getLowGlucoseSuspend
```
public SafetyLowGlucoseSuspend getLowGlucoseSuspend()
```
    Returns the glucose derivative value for the latest reading.
    
    Specified by:
    
    getLowGlucoseSuspend in interface SafetySystem
    
    Returns:
    
    the glucose derivative value or 0.0 if no reading is stored
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - hasCarbRecommendation
```
public boolean hasCarbRecommendation()
```
    Returns true if there is a carbohydrate recommendation.
    
    Specified by:
    
    hasCarbRecommendation in interface SafetySystem
    
    Returns:
    
    true if a new carbohydrate recommendation is issued.
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initalised
  - getCarbRecommendation
```
public double getCarbRecommendation()
```
    Returns the carbohydrate recommendation.
    
    Specified by:
    
    getCarbRecommendation in interface SafetySystem
    
    Returns:
    
    the carbohydrate recommendation value or 0.0 if no reading is stored
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getCarbRecommendationAsString
```
public java.lang.String getCarbRecommendationAsString()
```
    Returns the carbohydrate recommendation as a String.
    
    Specified by:
    
    getCarbRecommendationAsString in interface SafetySystem
    
    Returns:
    
    the carbohydrate recommendation value or 0.0 as a String if no reading is stored
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getGlucoseAlert
```
public SafetyGlucoseAlert getGlucoseAlert()
```
    Returns the glucose alert value for the latest reading.
    
    Specified by:
    
    getGlucoseAlert in interface SafetySystem
    
    Returns:
    
    the glucose alarm value (No Alarm, Hypo Alert, Hyper Alert) or No Alert if no reading is stored
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - hasGlucoseAlert
```
public boolean hasGlucoseAlert()
```
    Returns true if there is a glucose alert.
    
    Specified by:
    
    hasGlucoseAlert in interface SafetySystem
    
    Returns:
    
    true if there is a glucose alarm, otherwise false.
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getGlucoseAlarm
```
public SafetyGlucoseAlarm getGlucoseAlarm()
```
    Returns the glucose alarm value for the latest reading.
    
    Specified by:
    
    getGlucoseAlarm in interface SafetySystem
    
    Returns:
    
    the glucose alarm value (No Alarm, Hypo Alarm, Hyper Alarm) or 0 if no reading is stored
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - hasGlucoseAlarm
```
public boolean hasGlucoseAlarm()
```
    Returns true if there is a glucose alarm.
    
    Specified by:
    
    hasGlucoseAlarm in interface SafetySystem
    
    Returns:
    
    true if there is a glucose alarm, otherwise false.
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - hasFault
```
public boolean hasFault()
```
    Returns true if there is a fault.
    
    Specified by:
    
    hasFault in interface SafetySystem
    
    Returns:
    
    true if there is a fault, otherwise false
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initalised
  - getFault
```
public SafetyFault getFault()
```
    Determines whether there is a fault associated with the latest reading.
    
    Specified by:
    
    getFault in interface SafetySystem
    
    Returns:
    
    true if there is a fault associated with the latest reading, otherwise false
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getCarerAlarm
```
public SafetyCarerAlarm getCarerAlarm()
```
    Returns the carer alarm value for the latest reading.
    
    Specified by:
    
    getCarerAlarm in interface SafetySystem
    
    Returns:
    
    the carer alarm value (No Alarm, Hypo Alarm, Hyper Alarm, SafetyFault Alarm) or No Alarm if no reading is stored
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - hasCarerAlarm
```
public boolean hasCarerAlarm()
```
    Returns true if there is a carer alarm.
    
    Specified by:
    
    hasCarerAlarm in interface SafetySystem
    
    Returns:
    
    true if there is a carer alarm, otherwise false.
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getPatientId
```
public java.lang.String getPatientId()
```
    Returns the patient's unique id.
    
    Specified by:
    
    getPatientId in interface SafetySystem
    
    Returns:
    
    the patient's unique id
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getAlarmProfile
```
public SafetyAlarmProfile getAlarmProfile()
```
    Returns the current alarm profile.
    
    Specified by:
    
    getAlarmProfile in interface SafetySystem
    
    Returns:
    
    the current alarm profile
  - setAlarmProfile
```
public void setAlarmProfile(SafetyAlarmProfile profile)
```
    Sets or updates the safety system alarm profile.
    
    Specified by:
    
    setAlarmProfile in interface SafetySystem
    
    Parameters:
    
    profile - the alarm profile to be used
  - getGlucoseDerivative
```
public double getGlucoseDerivative()
```
    Returns the glucose derivative.
    
    Specified by:
    
    getGlucoseDerivative in interface SafetySystem
    
    Returns:
    
    the glucose derivative
  - clearDatabase
```
public void clearDatabase()
```
    Clears the database, this should be called after a successful JSON export.
    
    Specified by:
    
    clearDatabase in interface SafetySystem
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initalised
  - getHypoThreshold
```
public double getHypoThreshold()
```
    Gets the hypo threshold of the safety system.
    
    Specified by:
    
    getHypoThreshold in interface SafetySystem
    
    Returns:
    
    the hypo threshold of the safety system
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initalised
  - setHypoThreshold
```
public void setHypoThreshold(double hypoThreshold)
```
    Updates the hypo threshold of the safety system.
    
    Specified by:
    
    setHypoThreshold in interface SafetySystem
    
    Parameters:
    
    hypoThreshold - the hypo threshold
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initalised
  - getHyperThreshold
```
public double getHyperThreshold()
```
    Gets the hyper threshold of the safety system.
    
    Specified by:
    
    getHyperThreshold in interface SafetySystem
    
    Returns:
    
    the hyper threshold of the safety system
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initalised
  - setHyperThreshold
```
public void setHyperThreshold(double hyperThreshold)
```
    Updates the hyper threshold of the safety system.
    
    Specified by:
    
    setHyperThreshold in interface SafetySystem
    
    Parameters:
    
    hyperThreshold - the hypo threshold
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initalised
  - getCurrentISF
```
public double getCurrentISF()
```
    Returns the users current ISF value for the current system time.
    
    Specified by:
    
    getCurrentISF in interface SafetySystem
    
    Returns:
    
    the users ISF value
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initalised or if the users ISF values are invalid
  - getCurrentICR
```
public double getCurrentICR()
```
    Returns the users current ICR value for the current system time.
    
    Specified by:
    
    getCurrentICR in interface SafetySystem
    
    Returns:
    
    the users ICR value
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initalised or if the users ISF values are invalid
  - resumePumpOverride
```
public void resumePumpOverride()
```
    Forces the pump to fully resume for 60 minutes.
    
    Specified by:
    
    resumePumpOverride in interface SafetySystem
  - recalculateInsulin
```
public void recalculateInsulin(double insulinAdministered)
```
    Removes insulin from the Safety System Model for IoB correction when the pump is stopped
    
    Specified by:
    
    recalculateInsulin in interface SafetySystem
    
    Parameters:
    
    insulinAdministered - insulin actually administered
  - isCarerHyperAlarmEnabled
```
public boolean isCarerHyperAlarmEnabled()
```
    Returns true if carer hyper alarms are enabled.
    
    Specified by:
    
    isCarerHyperAlarmEnabled in interface SafetySystem
    
    Returns:
    
    true if carer hyper alarms are enabled
  - setCarerHyperAlarmEnabled
```
public void setCarerHyperAlarmEnabled(boolean enabled)
```
    Enables or disables carer hyper alarms.
    
    Specified by:
    
    setCarerHyperAlarmEnabled in interface SafetySystem
    
    Parameters:
    
    enabled - if true Hyper alarms for carers will be triggered.

Class PEPPERSafetySystem

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isValidPatientObject

initSafetySystem

isInitialised

isActive

setActive

update

addRecommendation

addCarbs

addInsulin

snoozeAlarm

acceptCarbRecommendation

declineCarbRecommendation

constrainBolus

createJsonExport

getCarbsOnBoard

getCarbsOnBoardAsString

getInsulinOnBoard

getInsulinOnBoardAsString

getGlucoseForecast

getGlucoseForecastAsString

getGlucoseTrend

getLowGlucoseSuspend

hasCarbRecommendation

getCarbRecommendation

getCarbRecommendationAsString

getGlucoseAlert

hasGlucoseAlert

getGlucoseAlarm

hasGlucoseAlarm

hasFault

getFault

getCarerAlarm

hasCarerAlarm

getPatientId

getAlarmProfile

setAlarmProfile

getGlucoseDerivative

clearDatabase

getHypoThreshold

setHypoThreshold

getHyperThreshold

setHyperThreshold

getCurrentISF

getCurrentICR

resumePumpOverride

recalculateInsulin

isCarerHyperAlarmEnabled

setCarerHyperAlarmEnabled