AlarmSource.h

Go to the documentation of this file.

#ifndef ACS_ALARMSOURCE_H
#define ACS_ALARMSOURCE_H
/*
 *    ALMA - Atacama Large Millimiter Array
 *    (c) European Southern Observatory, 2011
 *    Copyright by ESO (in the framework of the ALMA collaboration),
 *    All rights reserved
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 2.1 of the License, or (at your option) any later version.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA 02111-1307  USA
 */

#ifndef __cplusplus
#error This is a C++ include file and cannot be used from plain C
#endif

#include <string>

#include <acscommonC.h>
#include "Properties.h"

namespace acsalarm
{
        class AlarmSource {

        public:
                virtual ~AlarmSource() {}

                virtual void raiseAlarm(
                                std::string faultFamily,
                                std::string faultMember,
                                int faultCode)=0;

                virtual void raiseAlarm(
                                std::string faultFamily,
                                std::string faultMember,
                                int faultCode,
                                Properties properties)=0;

                virtual void clearAlarm(
                                std::string faultFamily,
                                std::string faultMember,
                                int faultCode)=0;

                virtual void setAlarm(
                                std::string faultFamily,
                                std::string faultMember,
                                int faultCode,
                                Properties alarmProps,
                                bool active)=0;

                virtual void setAlarm(
                                std::string faultFamily,
                                std::string faultMember,
                                int faultCode,
                                bool active)=0;

                virtual void terminateAllAlarms()=0;

                virtual void queueAlarms(ACS::TimeInterval time)=0;

                virtual void queueAlarms()=0;

                virtual void flushAlarms()=0;

                virtual void disableAlarms()=0;

                virtual void enableAlarms()=0;

                virtual void start()=0;

                virtual void tearDown()=0;

                virtual void update(ACS::Time now) {}
        };
}

#endif // ACS_ALARMSOURCE_H