AlarmedItem Class Reference

Basic hierarchical state item. More...

Inheritance diagram for AlarmedItem:

[legend]List of all members.

Public Member Functions
def	__init__
	AlarmedItem constructor.
def	parent
	return the parent AlarmedItem
def	state
	return the state of this object
def	children
	return the children of this object
def	newChild
	Add a child to the set of this object children.
def	isEnabled
	Is this item enabled?
def	enable
	Enable alarms on this object and all its children.
def	disable
	Disable alarms on this object and all its children.
def	iterateChildren
	iterate over the children of this method, calling a function on each
def	setState
	Set the state of the current object and propogate to parent if need be.
def	childStateSum
	Recalculate this object's state from its children.

---

Detailed Description

Basic hierarchical state item.

Definition at line 79 of file AlarmStates.py.

---

Member Function Documentation

def __init__ (    self,   parent = None,   state = AlarmState.Unknown )

AlarmedItem constructor. Parameters: parent  Item's parent. Default: None (No Parent) state  Item's starting state. Default: AlarmState.Unknown Definition at line 82 of file AlarmStates.py.

def children (    self  )

return the children of this object Returns: a List of AlarmedItem objects Definition at line 118 of file AlarmStates.py.

def childStateSum (    self  )

Recalculate this object's state from its children. Definition at line 199 of file AlarmStates.py.

def disable (    self,   disableChildren = True )

Disable alarms on this object and all its children. Parameters: disableChildren  Disable the children also (Default: True) Definition at line 151 of file AlarmStates.py.

def enable (    self,   enableChildren = True )

Enable alarms on this object and all its children. Parameters: enableChildren  Enable the children also (Default: True) Definition at line 141 of file AlarmStates.py.

def isEnabled (    self  )

Is this item enabled? Returns: boolean Definition at line 134 of file AlarmStates.py.

def iterateChildren (    self,   callback,   args )

iterate over the children of this method, calling a function on each Parameters: callback  A method *args  Arguments to be used for *each* callback Definition at line 161 of file AlarmStates.py.

def newChild (    self,   child )

Add a child to the set of this object children. Parameters: child  Definition at line 126 of file AlarmStates.py.

def parent (    self  )

return the parent AlarmedItem Returns: An AlarmedItem object, or None Definition at line 101 of file AlarmStates.py.

def setState (    self,   state,   forceUpdate = False )

Set the state of the current object and propogate to parent if need be. Parameters: state  Either an integer or an AlarmState object Reimplemented in QLV_AlarmedItem. Definition at line 174 of file AlarmStates.py.

def state (    self  )

return the state of this object Returns: An AlarmState object Definition at line 111 of file AlarmStates.py.

---

The documentation for this class was generated from the following file:

• AlarmStates.py

---