SafetySystem

All Known Implementing Classes:

PEPPERSafetySystem
```
public interface SafetySystem
```
Defines the Safety System interface.

Method Summary

All Methods Instance Methods Abstract 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.
`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 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 otherwise operations that effect.
`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.
`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.

- Method Detail
  - initSafetySystem
```
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 otherwise operations that effect.
    
    Parameters:
    
    json - the JSON to initialise the main Patient Object
    
    Returns:
    
    true if the Safety System is initialized
  - isInitialised
```
boolean isInitialised()
```
    Returns true if the Safety System has been initialised, otherwise false.
    
    Returns:
    
    true if the Safety System has been initialised, otherwise false
  - isActive
```
boolean isActive()
```
    Returns true if the safety system is active.
    
    Returns:
    
    true if the safety system is active, otherwise false
  - setActive
```
void setActive(boolean active)
```
    Set whether the safety system is active or not.
  - update
```
void update(java.util.Date date,
            double glucose)
```
    Runs the main algorithms of the Safety System, returning a Reading with the computed values.
    
    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
```
void addRecommendation(org.json.JSONObject caseJson)
                throws org.json.JSONException,
                       java.text.ParseException
```
    Registers a finalised case with the safety system.
    
    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
```
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.
    
    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
```
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.
    
    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
```
void snoozeAlarm(java.util.Date date)
```
    Snoozes the safety system alarms.
    
    Parameters:
    
    date - the datetime at which the update occurred
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - acceptCarbRecommendation
```
void acceptCarbRecommendation(java.util.Date date)
```
    Notifies the safety system that a carbohydrate recommendation has been accepted.
    
    Parameters:
    
    date - the datetime at which the update occurred
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - declineCarbRecommendation
```
void declineCarbRecommendation(java.util.Date date)
```
    Registers with the safety system that a carbohydrate recommendation has been declined.
    
    Parameters:
    
    date - the datetime at which the update occurred
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - constrainBolus
```
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.
    
    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
```
org.json.JSONObject createJsonExport()
                              throws org.json.JSONException
```
    Creates and returns the Safety System JSON Object.
    
    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
```
double getCarbsOnBoard()
```
    Returns the carbohydrates on board for the latest reading.
    
    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
```
java.lang.String getCarbsOnBoardAsString()
```
    Returns the carbohydrates on board for the latest reading as a String.
    
    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
```
double getInsulinOnBoard()
```
    Returns the insulin on board for the latest reading.
    
    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
```
java.lang.String getInsulinOnBoardAsString()
```
    Returns the insulin on board for the latest reading as a String.
    
    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
```
double getGlucoseForecast()
```
    Returns the glucose forecast value for the latest reading.
    
    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
```
java.lang.String getGlucoseForecastAsString()
```
    Returns the glucose forecast value for the latest reading as a String.
    
    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
```
SafetyGlucoseTrend getGlucoseTrend()
```
    Returns the glucose trend.
    
    Returns:
    
    the glucose trend
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getLowGlucoseSuspend
```
SafetyLowGlucoseSuspend getLowGlucoseSuspend()
```
    Returns the glucose derivative value for the latest reading.
    
    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
```
boolean hasCarbRecommendation()
```
    Returns true if there is a carbohydrate recommendation.
    
    Returns:
    
    true if a new carbohydrate recommendation is issued.
  - getCarbRecommendation
```
double getCarbRecommendation()
```
    Returns the carbohydrate recommendation.
    
    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
```
java.lang.String getCarbRecommendationAsString()
```
    Returns the carbohydrate recommendation as a String.
    
    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
```
SafetyGlucoseAlert getGlucoseAlert()
```
    Returns the glucose alert value for the latest reading.
    
    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
```
boolean hasGlucoseAlert()
```
    Returns true if there is a glucose alert.
    
    Returns:
    
    true if there is a glucose alarm, otherwise false.
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getGlucoseAlarm
```
SafetyGlucoseAlarm getGlucoseAlarm()
```
    Returns the glucose alarm value for the latest reading.
    
    Returns:
    
    the glucose alarm value (No Alarm, Hypo Alarm, Hyper Alarm) or No Alarm if no reading is stored
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - hasGlucoseAlarm
```
boolean hasGlucoseAlarm()
```
    Returns true if there is a glucose alarm.
    
    Returns:
    
    true if there is a glucose alarm, otherwise false.
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - hasFault
```
boolean hasFault()
```
    Returns true if there is a fault.
    
    Returns:
    
    true if there is a fault, otherwise false
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initalised
  - getFault
```
SafetyFault getFault()
```
    Determines whether there is a fault associated with the latest reading.
    
    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
```
SafetyCarerAlarm getCarerAlarm()
```
    Returns the carer alarm value for the latest reading.
    
    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
```
boolean hasCarerAlarm()
```
    Returns true if there is a carer alarm.
    
    Returns:
    
    true if there is a carer alarm, otherwise false.
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getAlarmProfile
```
SafetyAlarmProfile getAlarmProfile()
```
    Returns the current alarm profile.
    
    Returns:
    
    the current alarm profile
  - setAlarmProfile
```
void setAlarmProfile(SafetyAlarmProfile profile)
```
    Sets or updates the safety system alarm profile.
    
    Parameters:
    
    profile - the alarm profile to be used
  - getPatientId
```
java.lang.String getPatientId()
```
    Returns the patient id.
    
    Returns:
    
    the patient id
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initialised
  - getGlucoseDerivative
```
double getGlucoseDerivative()
```
    Returns the glucose derivative
    
    Returns:
    
    the glucose derivative
  - getHypoThreshold
```
double getHypoThreshold()
```
    Gets the hypo threshold of the safety system.
    
    Returns:
    
    the hypo threshold of the safety system
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initalised
  - setHypoThreshold
```
void setHypoThreshold(double hypoThreshold)
```
    Updates the hypo threshold of the safety system.
    
    Parameters:
    
    hypoThreshold - the hypo threshold
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initalised
  - getHyperThreshold
```
double getHyperThreshold()
```
    Gets the hyper threshold of the safety system.
    
    Returns:
    
    the hyper threshold of the safety system
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initalised
  - setHyperThreshold
```
void setHyperThreshold(double hyperThreshold)
```
    Updates the hyper threshold of the safety system.
    
    Parameters:
    
    hyperThreshold - the hypo threshold
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initalised
  - clearDatabase
```
void clearDatabase()
```
    Clears the database, this should be called after a successful JSON export.
    
    Throws:
    
    IllegalSafetySystemStateException - if the Safety System has not yet been initalised
  - getCurrentISF
```
double getCurrentISF()
```
    Returns the users current ISF value for the current system time.
    
    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
```
double getCurrentICR()
```
    Returns the users current ICR value for the current system time.
    
    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
```
void resumePumpOverride()
```
    Forces the pump to fully resume for 60 minutes.
  - recalculateInsulin
```
void recalculateInsulin(double insulinAdministered)
```
    Removes insulin from the Safety System Model for IoB correction when the pump is stopped
    
    Parameters:
    
    insulinAdministered - insulin actually administered
  - isCarerHyperAlarmEnabled
```
boolean isCarerHyperAlarmEnabled()
```
    Returns true if carer hyper alarms are enabled.
    
    Returns:
    
    true if carer hyper alarms are enabled
  - setCarerHyperAlarmEnabled
```
void setCarerHyperAlarmEnabled(boolean enabled)
```
    Enables or disables carer hyper alarms.
    
    Parameters:
    
    enabled - if true Hyper alarms for carers will be triggered.

Interface SafetySystem

Method Summary

Method Detail

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

getAlarmProfile

setAlarmProfile

getPatientId

getGlucoseDerivative

getHypoThreshold

setHypoThreshold

getHyperThreshold

setHyperThreshold

clearDatabase

getCurrentISF

getCurrentICR

resumePumpOverride

recalculateInsulin

isCarerHyperAlarmEnabled

setCarerHyperAlarmEnabled