Acsalarmpy.AlarmSystemInterface
index
/alma/ACS-2016.6/ACSSW/lib/python/site-packages/Acsalarmpy/AlarmSystemInterface.py

#*******************************************************************************
# ALMA - Atacama Large Millimiter Array
# (c) National Research Council of Canada, 2008 

# 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: AlarmSystemInterface.py,v 1.1 2008/10/09 16:11:10 agrimstrup Exp $"
#
# who       when      what
# --------  --------  ----------------------------------------------
# agrimstrup  2008-09-29  created
#

 
Modules
       
Acsalarmpy.ASI
Acspy.Common.Log
Acsalarmpy.Timestamp

 
Classes
       
__builtin__.object
AlarmSystemInterface

 
class AlarmSystemInterface(__builtin__.object)
    Alarm System Interface for Python alarm generators.  It is based
on CERN's Java implementation.
 
  Methods defined here:
__init__(self, sourceName=None, hostName=None)
Create an instance of the AlarmSystemInterface.
 
Parameters:  sourceName is the name of this source
             hostName is the name of the computer where the source is running.
close(self)
Clean up the resources used by this interface.  Must be implemented by
the subclasses.
publishMessage(self, msg)
Send a message to the LASER alarm server.  Must be implemented in the
subclasses using the desired communication mechanism.
 
Parameter:  msg is the ASIMessage to be sent.
push(self, state)
Push fault states to the LASER server.
 
Parameters: state is a single fault state or a list of fault states.
pushActiveList(self, activeFaults)
Pushes a list of active fault states to the LASER server.
 
Parameters: activeFaults is the list of fault states.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)