alarm.h

Go to the documentation of this file.

 
#pragma once
 
// INCLUDES =====================================================================
 
// Externals
#include <stdint.h>
 
// ENUMS =====================================================================
 
enum AlarmPriority { ALARM_NONE, ALARM_LOW, ALARM_MEDIUM, ALARM_HIGH };
 
// CLASS =====================================================================
 
class Alarm {
 public:
    Alarm(AlarmPriority p_priority, uint8_t p_code, uint8_t p_detectionThreshold);
 
    AlarmPriority getPriority() const;
 
    uint8_t getCode() const;
 
    bool isTriggered() const;
 
    uint32_t getCyclesSinceTrigger() const;
 
    void detected(uint32_t p_cycleNumber);
 
    void notDetected();
 
    void enable();
 
    void disable();
 
    bool isEnabled();
 
 private:
    AlarmPriority m_priority;
 
    uint8_t m_code;
 
    uint8_t m_detectionThreshold;
 
    uint8_t m_detectionNumber;
 
    uint32_t m_cycleNumber;
 
    uint32_t m_cyclesSinceTrigger;
 
    bool m_enabled;
};