rcCompletionStatus Class Reference

Completion code manager class. More...

List of all members.

Public Member Functions
def	getCompletionStatus
	Return the completion status code based on the description.
def	getCompletionStatusStr
	Return the completion status string based on the code.
def	isCompletionStatus
	Check if status is already in the dictionary.
def	addCompletionStatus
	Adds the new completion status code and its description to the dictionary.
def	getAll
	Return the completion status dictionary.
Static Public Attributes
tuple	getCompletionStatus = staticmethod(getCompletionStatus)
Static Private Attributes
dictionary	__csDict

---

Detailed Description

Completion code manager class.

This helper class provides methods to facilitate the management of completion codes.

Definition at line 21 of file rcComplStatus.py.

---

Member Function Documentation

def addCompletionStatus (    self,   status,   statusStr )

Adds the new completion status code and its description to the dictionary. Parameters: status  Completion status code statusStr  Completion status description Returns: 0: If add is successful. -1: If status code already exists. -2: If a duplicate description was found. Definition at line 67 of file rcComplStatus.py.

def getAll (    self  )

Return the completion status dictionary. Returns: Completion status dictionary. Definition at line 89 of file rcComplStatus.py.

def getCompletionStatus (    statStr  )

Return the completion status code based on the description. Parameters: statStr  Completion status description Returns: Completion status code or None if it doesn't exist. Definition at line 34 of file rcComplStatus.py.

def getCompletionStatusStr (    self,   status )

Return the completion status string based on the code. Parameters: status  Completion status code Returns: Completion status description or None if it doesn't exist. Definition at line 46 of file rcComplStatus.py.

def isCompletionStatus (    self,   status )

Check if status is already in the dictionary. Parameters: status  Completion status code Returns: True : If it is already defined. False: Otherwise Definition at line 57 of file rcComplStatus.py.

---

Member Data Documentation

dictionary __csDict [static, private]

Initial value: { 0: 'PASSED', -1: 'UNDEFINED', -2: 'ABORTED', -3: 'FAILED', -4: 'PASSED CONDITIONALLY', -5: 'MARGINAL', -6: 'OPERATOR ABORTED', -7: 'INCOMPLETE', } Definition at line 23 of file rcComplStatus.py.

tuple getCompletionStatus = staticmethod(getCompletionStatus) [static]

Definition at line 44 of file rcComplStatus.py.

---

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

• rcComplStatus.py

---