src/AlarmHandlerDynAttrUtils.cpp

+/*----- PROTECTED REGION ID(AlarmHandler::DynAttrUtils.cpp) ENABLED START -----*/
+//=============================================================================
+//
+// file :        AlarmHandlerDynAttrUtils.cpp
+//
+// description : Dynamic attributes utilities file for the AlarmHandler class
+//
+// project :     Elettra alarm handler device server
+//
+// This file is part of Tango device class.
+// 
+// Tango is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// Tango 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 General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with Tango.  If not, see <http://www.gnu.org/licenses/>.
+// 
+//
+//
+//=============================================================================
+//                This file is generated by POGO
+//        (Program Obviously used to Generate tango Object)
+//=============================================================================
+
+
+#include <AlarmHandler.h>
+#include <AlarmHandlerClass.h>
+
+/*----- PROTECTED REGION END -----*/	//	AlarmHandler::DynAttrUtils.cpp
+
+//================================================================
+//  Attributes managed are:
+//================================================================
+//  AlarmState    |  Tango::DevEnum	Scalar
+//  AlarmFormula  |  Tango::DevString	Scalar
+//================================================================
+
+//	For compatibility reason, this file (AlarmHandlerDynAttrUtils)
+//	manage also the dynamic command utilities.
+//================================================================
+//  The following table gives the correspondence
+//  between command and method names.
+//
+//  Command name  |  Method name
+//================================================================
+//================================================================
+
+namespace AlarmHandler_ns
+{
+//=============================================================
+//	Add/Remove dynamic attribute methods
+//=============================================================
+
+//--------------------------------------------------------
+/**
+ *	Add a AlarmState dynamic attribute.
+ *
+ *  parameter attname: attribute name to be cretated and added.
+ */
+//--------------------------------------------------------
+void AlarmHandler::add_AlarmState_dynamic_attribute(string attname)
+{
+	//	Attribute : AlarmState
+	AlarmStateAttrib	*alarmstate = new AlarmStateAttrib(attname);
+	Tango::UserDefaultAttrProp	alarmstate_prop;
+	//	description	not set for AlarmState
+	//	label	not set for AlarmState
+	//	unit	not set for AlarmState
+	//	standard_unit	not set for AlarmState
+	//	display_unit	not set for AlarmState
+	//	format	not set for AlarmState
+	//	max_value	not set for AlarmState
+	//	min_value	not set for AlarmState
+	//	max_alarm	not set for AlarmState
+	//	min_alarm	not set for AlarmState
+	//	max_warning	not set for AlarmState
+	//	min_warning	not set for AlarmState
+	//	delta_t	not set for AlarmState
+	//	delta_val	not set for AlarmState
+	
+	/*----- PROTECTED REGION ID(AlarmHandler::att_AlarmState_dynamic_attribute) ENABLED START -----*/
+	DEBUG_STREAM << __func__<<": entering name="<<attname;
+	alarm_container_t::iterator i = alarms.v_alarm.find(attname);
+	if(i != alarms.v_alarm.end())
+	{
+		alarmstate_prop.set_description(i->second.formula.c_str());
+	}
+	else
+	{
+		INFO_STREAM << __func__<<": name="<<attname<<" NOT FOUND while looking for formula to add as attribute description";
+	}
+	
+	/*----- PROTECTED REGION END -----*/	//	AlarmHandler::att_AlarmState_dynamic_attribute
+	{
+		vector<string> labels;
+		labels.push_back("NORM");
+		labels.push_back("UNACK");
+		labels.push_back("ACKED");
+		labels.push_back("RTNUN");
+		labels.push_back("SHLVD");
+		labels.push_back("DSUPR");
+		labels.push_back("OOSRV");
+		labels.push_back("ERROR");
+		alarmstate_prop.set_enum_labels(labels);
+	}
+	alarmstate->set_default_properties(alarmstate_prop);
+	//	Not Polled
+	alarmstate->set_disp_level(Tango::OPERATOR);
+	//	Not Memorized
+	alarmstate->set_change_event(true, true);
+	alarmstate->set_archive_event(true, true);
+	AlarmState_data.insert(make_pair(attname, 0));
+	add_attribute(alarmstate);
+}
+//--------------------------------------------------------
+/**
+ *	remove a AlarmState dynamic attribute.
+ *
+ *  parameter attname: attribute name to be removed.
+ */
+//--------------------------------------------------------
+void AlarmHandler::remove_AlarmState_dynamic_attribute(string attname)
+{
+	remove_attribute(attname, true, Tango::Util::instance()->_UseDb);
+	map<string,Tango::DevEnum>::iterator ite;
+    if ((ite=AlarmState_data.find(attname))!=AlarmState_data.end())
+    {
+    	/*----- PROTECTED REGION ID(AlarmHandler::remove_AlarmState_dynamic_attribute) ENABLED START -----*/
+    	DEBUG_STREAM << __func__<<": entering name="<<attname;
+    	/*----- PROTECTED REGION END -----*/	//	AlarmHandler::remove_AlarmState_dynamic_attribute
+		AlarmState_data.erase(ite);
+	}
+}
+//--------------------------------------------------------
+/**
+ *	Add a AlarmFormula dynamic attribute.
+ *
+ *  parameter attname: attribute name to be cretated and added.
+ */
+//--------------------------------------------------------
+void AlarmHandler::add_AlarmFormula_dynamic_attribute(string attname)
+{
+	//	Attribute : AlarmFormula
+	AlarmFormulaAttrib	*alarmformula = new AlarmFormulaAttrib(attname);
+	Tango::UserDefaultAttrProp	alarmformula_prop;
+	//	description	not set for AlarmFormula
+	//	label	not set for AlarmFormula
+	//	unit	not set for AlarmFormula
+	//	standard_unit	not set for AlarmFormula
+	//	display_unit	not set for AlarmFormula
+	//	format	not set for AlarmFormula
+	//	max_value	not set for AlarmFormula
+	//	min_value	not set for AlarmFormula
+	//	max_alarm	not set for AlarmFormula
+	//	min_alarm	not set for AlarmFormula
+	//	max_warning	not set for AlarmFormula
+	//	min_warning	not set for AlarmFormula
+	//	delta_t	not set for AlarmFormula
+	//	delta_val	not set for AlarmFormula
+	
+	/*----- PROTECTED REGION ID(AlarmHandler::att_AlarmFormula_dynamic_attribute) ENABLED START -----*/
+	DEBUG_STREAM << __func__<<": entering name="<<attname;
+	
+	/*----- PROTECTED REGION END -----*/	//	AlarmHandler::att_AlarmFormula_dynamic_attribute
+	alarmformula->set_default_properties(alarmformula_prop);
+	//	Not Polled
+	alarmformula->set_disp_level(Tango::OPERATOR);
+	//	Not Memorized
+	alarmformula->set_change_event(true, true);
+	alarmformula->set_archive_event(true, true);
+	char array[1];
+	array[0] = '\0';
+	AlarmFormula_data.insert(make_pair(attname, array));
+	add_attribute(alarmformula);
+}
+//--------------------------------------------------------
+/**
+ *	remove a AlarmFormula dynamic attribute.
+ *
+ *  parameter attname: attribute name to be removed.
+ */
+//--------------------------------------------------------
+void AlarmHandler::remove_AlarmFormula_dynamic_attribute(string attname)
+{
+	remove_attribute(attname, true, Tango::Util::instance()->_UseDb);
+	map<string,Tango::DevString>::iterator ite;
+    if ((ite=AlarmFormula_data.find(attname))!=AlarmFormula_data.end())
+    {
+    	/*----- PROTECTED REGION ID(AlarmHandler::remove_AlarmFormula_dynamic_attribute) ENABLED START -----*/
+    	
+    	/*----- PROTECTED REGION END -----*/	//	AlarmHandler::remove_AlarmFormula_dynamic_attribute
+		AlarmFormula_data.erase(ite);
+	}
+}
+
+
+//============================================================
+//	Tool methods to get pointer on attribute data buffer 
+//============================================================
+//--------------------------------------------------------
+/**
+ *	Return a pointer on AlarmState data.
+ *
+ *  parameter attname: the specified attribute name.
+ */
+//--------------------------------------------------------
+Tango::DevEnum *AlarmHandler::get_AlarmState_data_ptr(string &name)
+{
+	map<string,Tango::DevEnum>::iterator ite;
+    if ((ite=AlarmState_data.find(name))==AlarmState_data.end())
+    {
+		TangoSys_OMemStream	tms;
+		tms << "Dynamic attribute " << name << " has not been created";
+		Tango::Except::throw_exception(
+					(const char *)"ATTRIBUTE_NOT_FOUND",
+					tms.str().c_str(),
+					(const char *)"AlarmHandler::get_AlarmState_data_ptr()");
+    }
+	return  &(ite->second);
+}
+//--------------------------------------------------------
+/**
+ *	Return a pointer on AlarmFormula data.
+ *
+ *  parameter attname: the specified attribute name.
+ */
+//--------------------------------------------------------
+Tango::DevString *AlarmHandler::get_AlarmFormula_data_ptr(string &name)
+{
+	map<string,Tango::DevString>::iterator ite;
+    if ((ite=AlarmFormula_data.find(name))==AlarmFormula_data.end())
+    {
+		TangoSys_OMemStream	tms;
+		tms << "Dynamic attribute " << name << " has not been created";
+		Tango::Except::throw_exception(
+					(const char *)"ATTRIBUTE_NOT_FOUND",
+					tms.str().c_str(),
+					(const char *)"AlarmHandler::get_AlarmFormula_data_ptr()");
+    }
+	return  &(ite->second);
+}
+
+
+//=============================================================
+//	Add/Remove dynamic command methods
+//=============================================================
+
+
+} //	namespace

src/CMakeLists.txt

+cmake_minimum_required(VERSION 3.2)
+
+# source files
+set(SRC_FILES ${SRC_FILES}
+    ${CMAKE_CURRENT_SOURCE_DIR}/AlarmHandler.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/AlarmHandlerClass.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/AlarmHandlerDynAttrUtils.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/AlarmHandlerStateMachine.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/alarm_table.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/alarm-thread.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/ClassFactory.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/cmd_thread.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/event_table.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/main.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/SubscribeThread.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/update-thread.cpp
+    PARENT_SCOPE)

src/ClassFactory.cpp

+/*----- PROTECTED REGION ID(AlarmHandler::ClassFactory.cpp) ENABLED START -----*/
+//=============================================================================
+//
+// file :        ClassFactory.cpp
+//
+// description : C++ source for the class_factory method of the DServer
+//               device class. This method is responsible for the creation of
+//               all class singleton for a device server. It is called
+//               at device server startup.
+//
+// project :     Elettra alarm handler device server
+//
+// This file is part of Tango device class.
+// 
+// Tango is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// Tango 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 General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with Tango.  If not, see <http://www.gnu.org/licenses/>.
+// 
+//
+//
+//=============================================================================
+//                This file is generated by POGO
+//        (Program Obviously used to Generate tango Object)
+//=============================================================================
+
+#include <tango/tango.h>
+#include <AlarmHandlerClass.h>
+
+//	Add class header files if needed
+
+
+/**
+ *	Create AlarmHandler Class singleton and store it in DServer object.
+ */
+
+void Tango::DServer::class_factory()
+{
+	//	Add method class init if needed
+	add_class(AlarmHandler_ns::AlarmHandlerClass::init("AlarmHandler"));
+}
+/*----- PROTECTED REGION END -----*/	//	AlarmHandler::ClassFactory.cpp

src/SubscribeThread.cpp

+#include "AlarmHandler.h"
+#include "event_table.h"
+
+
+namespace AlarmHandler_ns
+{
+
+//=============================================================================
+//=============================================================================
+SubscribeThread::SubscribeThread(AlarmHandler *dev):Tango::LogAdapter(dev)
+{
+	alarm_dev = dev;
+	period = 10;	//TODO: configurable
+	shared  = dev->events;
+}
+//=============================================================================
+//=============================================================================
+void SubscribeThread::updateProperty()
+{
+	shared->put_signal_property();
+}
+//=============================================================================
+//=============================================================================
+void SubscribeThread::signal()
+{
+	shared->signal();
+}
+//=============================================================================
+//=============================================================================
+void *SubscribeThread::run_undetached(void *ptr)
+{
+	INFO_STREAM << "SubscribeThread id="<<omni_thread::self()->id()<<endl;
+	while(shared->get_if_stop()==false)
+	{
+		//	Try to subscribe
+		usleep(500000);		//TODO: try to delay a bit subscribe_events
+		if(shared->get_if_stop())
+			break;
+		DEBUG_STREAM << "SubscribeThread::"<<__func__<<": AWAKE"<<endl;
+		updateProperty();
+		alarm_dev->events->subscribe_events();
+		int	nb_to_subscribe = shared->nb_sig_to_subscribe();
+		shared->check_signal_property(); //check if, while subscribing, new alarms to be saved in properties where added (update action)
+		//	And wait a bit before next time or
+		//	wait a long time if all signals subscribed
+		{
+			omni_mutex_lock sync(*shared);
+			//shared->lock();
+			int act=shared->action.load();
+			if (nb_to_subscribe==0 && act == NOTHING)
+			{
+				DEBUG_STREAM << "SubscribeThread::"<<__func__<<": going to wait nb_to_subscribe=0"<<endl;
+				//shared->condition.wait();
+				shared->wait();
+				//shared->wait(3*period*1000);
+			}
+			else if(shared->action == NOTHING)
+			{
+				DEBUG_STREAM << "SubscribeThread::"<<__func__<<": going to wait period="<<period<<"  nb_to_subscribe="<<nb_to_subscribe<<endl;
+				//unsigned long s,n;
+				//omni_thread::get_time(&s,&n,period,0);
+				//shared->condition.timedwait(s,n);
+				shared->wait(period*1000);
+			}
+			//shared->unlock();
+		}
+	}
+	//shared->unsubscribe_events();
+	INFO_STREAM <<"SubscribeThread::"<< __func__<<": exiting..."<<endl;
+	return NULL;
+}
+//=============================================================================
+//=============================================================================
+
+
+
+}	//	namespace

src/SubscribeThread.h

+#ifndef _SUBSCRIBE_THREAD_H
+#define _SUBSCRIBE_THREAD_H
+
+#include <tango/tango.h>
+#include <stdint.h>
+#include "event_table.h"
+
+//	constants definitions here.
+//-----------------------------------------------
+
+namespace AlarmHandler_ns
+{
+
+//class ArchiveCB;
+class AlarmHandler;
+
+class SubscribeThread;
+
+//=========================================================
+/**
+ *	Create a thread retry to subscribe event.
+ */
+//=========================================================
+class SubscribeThread: public omni_thread, public Tango::LogAdapter
+{
+private:
+	/**
+	 *	Shared data
+	 */
+	event_table	*shared;
+	/**
+	 *	HdbDevice object
+	 */
+	AlarmHandler	*alarm_dev;
+
+
+public:
+	int			period;
+	SubscribeThread(AlarmHandler *dev);
+	void updateProperty();
+	void signal();
+	/**
+	 *	Execute the thread loop.
+	 *	This thread is awaken when a command has been received 
+	 *	and falled asleep when no command has been received from a long time.
+	 */
+	void *run_undetached(void *);
+	void start() {start_undetached();}
+};
+
+
+}	// namespace_ns
+
+#endif	// _SUBSCRIBE_THREAD_H

src/alarm-thread.cpp

+/*
+ * alarm-thread.cpp
+ *
+ * copyleft: Sincrotrone Trieste S.C.p.A. di interesse nazionale
+ *           Strada Statale 14 - km 163,5 in AREA Science Park
+ *           34012 Basovizza, Trieste ITALY
+ */
+
+#include "alarm-thread.h"
+static const char __FILE__rev[] = __FILE__ " $Revision: 1.7 $";
+
+/*
+ * alarm_thread::alarm_thread()
+ */
+alarm_thread::alarm_thread(AlarmHandler_ns::AlarmHandler *p) : p_Alarm(p)
+{
+	//TANGO_LOG << __FILE__rev << endl;
+}
+
+/*
+ * alarm_thread::~alarm_thread()
+ */
+alarm_thread::~alarm_thread()
+{
+	p_Alarm = NULL;
+}
+
+/*
+ * alarm_thread::run()
+ */
+void alarm_thread::run(void *)
+{
+	size_t to_be_evaluated = 0;
+	//int period = 5; //seconds
+	int awaken = 0;
+	vector<string> alm_to_be_eval;
+	bool starting = true;
+	timespec now;
+	clock_gettime(CLOCK_MONOTONIC, &now);
+	double last_eval = (now.tv_sec) + ((double)(now.tv_nsec))/1000000000;
+
+	while(starting)
+	{
+		starting = Tango::Util::instance()->is_svr_starting();
+		usleep(200000);
+	}
+
+	alm_to_be_eval = p_Alarm->alarms.to_be_evaluated_list();
+	to_be_evaluated = alm_to_be_eval.size();
+
+	while (true) {
+		/*
+		 * pop_front() will wait() on condition variable
+		 */
+		try
+		{
+			if(to_be_evaluated > 0)
+			{
+				clock_gettime(CLOCK_MONOTONIC, &now);
+				double dnow = (now.tv_sec) + ((double)(now.tv_nsec))/1000000000;
+				if(dnow - last_eval > 10)	//TODO: configurable
+				{
+					last_eval = dnow;
+					bool changed = true;
+					int num_changed = 0;
+					if(alm_to_be_eval.size() > 0)
+					{
+						for(vector<string>::iterator i = alm_to_be_eval.begin(); i != alm_to_be_eval.end(); i++)
+						{
+							changed = p_Alarm->do_alarm_eval(*i, "FORCED_EVAL", gettime());
+							if(changed)
+								num_changed++;
+						}
+#if 0	//TODO
+						prepare_alarm_attr();
+						if(num_changed==0)
+							return;
+						if(ds_num == 0)
+						{
+							//attr.set_value_date_quality(ds,0/*gettime()*/,Tango::ATTR_WARNING, ds_num, 0, false);
+							struct timeval now;
+							gettimeofday(&now,NULL);
+							push_change_event("alarm",(char**)ds,now,Tango::ATTR_WARNING, ds_num, 0, false);
+						}
+						else
+							//attr.set_value(ds, ds_num, 0, false);
+							push_change_event("alarm",ds, ds_num, 0, false);
+#endif
+					}
+#if 1
+					alm_to_be_eval = p_Alarm->alarms.to_be_evaluated_list();
+					to_be_evaluated = alm_to_be_eval.size();
+#else
+					to_be_evaluated = 0;
+#endif
+					//usleep(200000);	//TODO
+				}
+			}
+			bei_t e;
+			{
+				e = p_Alarm->evlist.pop_front();
+				//DEBUG_STREAM << "alarm_thread::run(): woken up!!!! " << e.name << endl;
+				if ((e.ev_name == ALARM_THREAD_EXIT) && \
+					(e.value[0] == ALARM_THREAD_EXIT_VALUE))
+				{
+					break;
+				}
+				else if ((e.ev_name == ALARM_THREAD_TO_BE_EVAL) && \
+					(e.value[0] == ALARM_THREAD_TO_BE_EVAL_VALUE))
+				{
+					alm_to_be_eval = p_Alarm->alarms.to_be_evaluated_list();
+					to_be_evaluated = alm_to_be_eval.size();
+					continue;
+				}
+				p_Alarm->do_alarm(e);
+			}
+		}
+		catch(omni_thread_fatal& ex)
+		{
+			ostringstream err;
+			err << "omni_thread_fatal exception running alarm thread, err=" << ex.error << ends;
+			//WARN_STREAM << "alarm_thread::run(): " << err.str() << endl;	
+			printf("alarm_thread::run(): %s\n", err.str().c_str());
+		}			
+		catch(Tango::DevFailed& ex)
+		{
+			ostringstream err;
+			err << "exception running alarm thread: '" << ex.errors[0].desc << "'" << ends;
+			//WARN_STREAM << "alarm_thread::run(): " << err.str() << endl;	
+			printf("alarm_thread::run(): %s\n", err.str().c_str());
+			//Tango::Except::print_exception(ex);
+		}		
+		catch(...)
+		{
+			//WARN_STREAM << "alarm_thread::run(): catched unknown exception!!" << endl;
+			printf("alarm_thread::run(): catched unknown exception!!\n");
+		}		
+	}
+	//TANGO_LOG << "alarm_thread::run(): returning" << endl;
+}  /* alarm_thread::run() */

src/alarm-thread.h

+/*
+ * alarm-thread.h
+ *
+ * copyleft: Sincrotrone Trieste S.C.p.A. di interesse nazionale
+ *           Strada Statale 14 - km 163,5 in AREA Science Park
+ *           34012 Basovizza, Trieste ITALY
+ */
+
+#ifndef ALARM_THREAD_H
+#define ALARM_THREAD_H
+
+#include <omnithread.h>
+#include <tango/tango.h>
+#include <AlarmHandler.h>
+
+#define ALARM_THREAD_EXIT				"alarm_thread_exit"
+#define ALARM_THREAD_EXIT_VALUE	-100
+#define ALARM_THREAD_TO_BE_EVAL			"to_be_evaluated"
+#define ALARM_THREAD_TO_BE_EVAL_VALUE	-200
+
+class alarm_thread : public omni_thread {
+	public:
+		alarm_thread(AlarmHandler_ns::AlarmHandler *p);
+		~alarm_thread();
+		//int period;
+	protected:
+		void run(void *);
+	private:
+		AlarmHandler_ns::AlarmHandler *p_Alarm;
+};
+
+#endif	/* ALARM_THREAD_H */
+
+/* EOF */