src/o1/AlarmManager.hpp

   1 /*******************************************************************************
   2 ################################################################################
   3 #   Copyright (c) [2020] [HCL Technologies Ltd.]                               #
   4 #                                                                              #
   5 #   Licensed under the Apache License, Version 2.0 (the "License");            #
   6 #   you may not use this file except in compliance with the License.           #
   7 #   You may obtain a copy of the License at                                    #
   8 #                                                                              #
   9 #       http://www.apache.org/licenses/LICENSE-2.0                             #
  10 #                                                                              #
  11 #   Unless required by applicable law or agreed to in writing, software        #
  12 #   distributed under the License is distributed on an "AS IS" BASIS,          #
  13 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
  14 #   See the License for the specific language governing permissions and        #
  15 #   limitations under the License.                                             #
  16 ################################################################################
  17 *******************************************************************************/
  18
  19 /* This file contains AlarmManager singleton class responsible for
  20    storing and managing alarms.
  21 */
  22
  23 #ifndef __ALARM_MANAGER_HPP__
  24 #define __ALARM_MANAGER_HPP__
  25
  26 #include <map>
  27 #include "Alarm.hpp"
  28 #include "Singleton.hpp"
  29
  30 using std::map;
  31
  32
  33 class AlarmManager : public Singleton<AlarmManager>
  34 {
  35
  36    friend Singleton<AlarmManager>;
  37
  38    private:
  39    map<uint16_t,Alarm> mAlarmList;
  40
  41    protected:
  42    AlarmManager();
  43    ~AlarmManager();
  44
  45    public:
  46    bool raiseAlarm(const Alarm& alarm);
  47    bool clearAlarm(const uint16_t& alarmId);
  48    bool clearAlarm(const Alarm& alarm );
  49    const map<uint16_t, Alarm>& getAlarmList()const;
  50
  51 };
  52
  53
  54 #endif
  55
  56 /**********************************************************************
  57          End of file
  58 **********************************************************************/