ACSAlarmSystemInterfaceFactory.h

Go to the documentation of this file.

#ifndef ACS_ALARM_SYSTEM_INTERFACE_FACTORY_H
#define ACS_ALARM_SYSTEM_INTERFACE_FACTORY_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$"
*
* who       when      what
* --------  --------  ----------------------------------------------
* acaproni  2006-07-12  created
*/

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

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

#include "AlarmSystemInterfaceFactory.h"
#include "AlarmSystemInterface.h"
#include "ACSAlarmSystemInterfaceFactory.h"
#include "ACSAlarmSystemInterfaceProxy.h"
#include "utilConstants.h"
#include "maciS.h"
#include "acsErrTypeAlarmSourceFactory.h"
#include <orbsvcs/CosNotifyChannelAdminS.h>
#include <orbsvcs/CosNotifyCommC.h>
#include "asiConfigurationConstants.h"
#include "ace/Task.h"

enum AlarmSystemType {
        NOT_YET_INITIALIZED, // unknown type: not initialized
        CERN_AS, // CERN implementation
        ACS_AS  // ACS implementation
};

class ACSAlarmSystemInterfaceFactory
// TODO: Alessandro, can this class extend AlarmSystemInterfaceFactory? 
// We would need to make static methods non-static to do so...
{
        private:

        // used for loading/unloading the DLL which is used to decouple (for build purposes) 
        // the logic in ACSLaser/laser-source-cpp
        static void *dllHandle;

        // At the present all the alarms are mapped in the same NC
        // so we need only one source to publish all the alarms
        static acsalarm::AlarmSystemInterface* m_sourceSingleton_p;

        // The type of alarm system in use.
        static AlarmSystemType m_AlarmSystemType;
                
        // The manager
        static maci::Manager_ptr m_manager;

        // Pointer to CERN alarm system object; will remain null if we are not using CERN implementation
        static AlarmSystemInterfaceFactory * m_AlarmSystemInterfaceFactory_p;

        // used to synchronize access to shared vars
        static ACE_Recursive_Thread_Mutex main_mutex;

        ACSAlarmSystemInterfaceFactory();
        ACSAlarmSystemInterfaceFactory(const ACSAlarmSystemInterfaceFactory&);
        ACSAlarmSystemInterfaceFactory operator=(const ACSAlarmSystemInterfaceFactory&);
        ~ACSAlarmSystemInterfaceFactory();

        static void cleanUpAlarmSystemInterfacePtr();
        static void cleanUpSourceSingleton();
        static void cleanUpDLL();
        static void cleanUpManagerReference();
        static void initImplementationType(maci::Manager_ptr manager);
        static bool initDLL();
        
        static acsalarm::AlarmSystemInterface* getSourceSingleton();

        public:

        static maci::Manager_ptr getManager();

        static bool init(maci::Manager_ptr manager) throw (acsErrTypeAlarmSourceFactory::ErrorLoadingCERNDLLExImpl);

        static AlarmSystemType usingACSAlarmSystem() throw (acsErrTypeAlarmSourceFactory::ACSASFactoryNotInitedExImpl);
                
        static void done();
        
        static acsalarm::AlarmSystemInterface* createSource(std::string sourceName) throw (acsErrTypeAlarmSourceFactory::ACSASFactoryNotInitedExImpl);
                
        static acsalarm::AlarmSystemInterface* createSource() throw (acsErrTypeAlarmSourceFactory::ACSASFactoryNotInitedExImpl);
        
        static std::auto_ptr<acsalarm::FaultState>createFaultState(std::string family, std::string member, int code) throw (acsErrTypeAlarmSourceFactory::ACSASFactoryNotInitedExImpl);
        
        static std::auto_ptr<acsalarm::FaultState>createFaultState() throw (acsErrTypeAlarmSourceFactory::ACSASFactoryNotInitedExImpl);

        static void createAndSendAlarm(std::string & faultFamily, std::string & faultMember, int faultCode, bool active, std::string sourceName = asiConfigurationConstants::ALARM_SOURCE_NAME)
                          throw (acsErrTypeAlarmSourceFactory::ACSASFactoryNotInitedExImpl);

        static void createAndSendAlarm(std::string & faultFamily, std::string & faultMember, int faultCode, bool active, acsalarm::Properties & faultProperties, 
                std::string sourceName = asiConfigurationConstants::ALARM_SOURCE_NAME) throw (acsErrTypeAlarmSourceFactory::ACSASFactoryNotInitedExImpl);

};

#endif