Changeset 1507

Timestamp:

Feb 18, 2014 12:09:54 PM (10 years ago)

Author:

jemian

Message:

trim up the API a bit

File:

• topdoc/trunk/src/bcda/ask_alive.py (modified) (5 diffs)

topdoc/trunk/src/bcda/ask_alive.py

@@ -3 +3 @@
 '''ask_alive: get BCDA IOC information
 
-On the APS internal network, query the BCDA alive support
+On the APS internal network, query the BCDA alive record service
 for recent information about the status of known IOCs.
+
+EXAMPLE::
+
+  from bcda.ask_alive import identify_iocs
+  known_ioc_dict = identify_iocs()      # get a dictionary of known IOCs from "alive"
+  for name in known_ioc_dict.keys():
+      print name, known_ioc_dict[name].alive
+
 '''
 
@@ -22 +30 @@
                 self.name = ''
                 self.address = ''
-                self.timer = ''
+                self.timer = 0
                 self.uptime = ''
                 self.downtime = ''
+                self.alive = False
                 self.env = dict(ARCH='', TOP='', EPICS_BASE='', 
                                                 SUPPORT='', LOCATION='', ENGINEER='')
@@ -43 +52 @@
                                 self.env[key] = value
 
+                self.alive = self.timer < TIMER_THRESHOLD_DEAD_IOC
+
         def subnode_text(self, node, subnode_tag):
                 '''return the text from the named subnode'''
@@ -56 +67 @@
         '''read all the IOCs from the XML document, return as {name:Ioc()}'''
         doc = etree.parse(xml_source)
-        version = doc.getroot().get('version', UNVERSIONED_XML)
+        root = doc.getroot()
+        version = root.get('version', UNVERSIONED_XML)
         if version not in (UNVERSIONED_XML):
                 raise RuntimeError, 'unexpected version: ' + version
@@ -79 +91 @@
                 c += 1
                 row = [c, k, ioc.address,]
-                if ioc.timer < TIMER_THRESHOLD_DEAD_IOC:
+                if ioc.alive:
                         row.append(ioc.uptime)
                 else: