AlarmState Class Reference

Settable limit state class. More...

List of all members.

Public Member Functions
def	__init__
	AlarmState constructor.
def	setState
	Set the current state.
def	stateEnum
	return the current integer state value
def	state
	Return a string defining the current state.
def	__setState
def	__cmp__
	Comparison operator.
Private Attributes
	__state

---

Detailed Description

Settable limit state class.

Definition at line 25 of file AlarmStates.py.

---

Member Function Documentation

def __cmp__ (    self,   state )

Comparison operator. Allows state1 < state2 Definition at line 71 of file AlarmStates.py.

def __init__ (    self,   state = LimitState.NoLimit )

AlarmState constructor. Parameters: state  Starting state. Default: LimitState.Unknown Definition at line 27 of file AlarmStates.py.

def __setState (    self,   newState )

Definition at line 62 of file AlarmStates.py.

def setState (    self,   newState )

Set the current state. Parameters: newState  A LimitState member or an integer Returns: Can throw an exception if newState isn't allowed. Definition at line 39 of file AlarmStates.py.

def state (    self  )

Return a string defining the current state. Returns: String state value Definition at line 55 of file AlarmStates.py.

def stateEnum (    self  )

return the current integer state value Returns: Integer state value Definition at line 48 of file AlarmStates.py.

---

Member Data Documentation

__state [private]

Definition at line 64 of file AlarmStates.py.

---

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

• AlarmStates.py

---