baciAlarmSystemMonitorBase.h

Go to the documentation of this file.

#ifndef _ALARM_SYSTEM_MONITOR_BASE_H
#define _ALARM_SYSTEM_MONITOR_BASE_H
/*******************************************************************************
 * ALMA - Atacama Large Millimiter Array
 * (c) European Southern Observatory, 2006
 *
 * 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
 *
 * "@(#) $Id: baciAlarmSystemMonitorBase.h,v 1.4 2011/09/02 11:39:00 bjeram Exp $"
 *
 * who       when      what
 * --------  --------  ----------------------------------------------
 * bjeram  2006-09-13  created
 */

/************************************************************************
 *
 *----------------------------------------------------------------------
 */

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

#include <AlarmSystemInterface.h>
#include <baciEvent.h>

namespace baci
{

class baci_EXPORT AlarmSystemMonitorBase : public EventStrategy
{
public:

        AlarmSystemMonitorBase(EventDispatcher * eventDispatcher);

        virtual ~AlarmSystemMonitorBase();

        bool failed();
        void succeeded();

        virtual bool isSuspended() { return false; }

        // here we do not need recovery stuff
        virtual int getId(void){ return -1; }

        virtual const char* getName(void){ return ""; }

        virtual const char* getObjectState(void){ return ""; }

        virtual void setObjectState(const char * state){}
        // ... and also implementation of  POA_ACS::Subscription can be empty
        virtual void suspend () {}

        virtual void resume () {}

        virtual void destroy () {}

        void setLevel(int level){ alarmLevel_m = level; }

        void setFaultFamily(const char *ff);

        void setFaultMember(const char *fm);

protected:

        virtual void check(BACIValue &val,
                        const ACSErr::Completion & c,
                        const ACS::CBDescOut & desc )=0;

        void sendAlarm(int code, bool active);


        virtual void clearAlarm();


        virtual void recheckAlarm();

        void setProperty(const char *name, const char *prop);

        template <class VT>
        void setProperty(const char *name, VT value)
        {
                std::ostringstream ostr;
                std::string ts;

                ostr << value << std::ends;
                ts =  ostr.str();
                setProperty(name, ts.c_str());
        }//setProperty<>


private:

        void operator=(const AlarmSystemMonitorBase&);

        AlarmSystemMonitorBase(const AlarmSystemMonitorBase&);


protected:
        ACE_CString name_m;

        bool suspended_m;

        int failureCount_m;

        CBDescIn desc_mIn;

        ACS::TimeInterval interval_m;

        EventDispatcher * eventDispatcher_mp;

        // The alarm system source
        // The source is a singleton (there is no need to delete this pointer)
        acsalarm::AlarmSystemInterface* alarmSource_map;

        int alarmRaised_m;

        std::string faultMember_m;  
        std::string faultFamily_m;  

        int alarmLevel_m;  


        int lastAlarmFaultCode_m; 
        BACIValue lastAlarmValue_m;     //value that caused (raised or cleared) the last alarm

        // here we can store alarm propertes
        std::map<std::string, std::string> alarmProperties_m;

        ACE_Recursive_Thread_Mutex faultStructMutex_m;
};//class AlarmSystemMonitorBase

}// namespace baci

#endif