rcCompletionStatus Class Reference

List of all members.

Public Member Functions
	getCompletionStatusStr (status)
	isCompletionStatus (status)
	addCompletionStatus (status, statusStr)
	getAll ()
Static Public Member Functions
static	getCompletionStatus (statStr)

---

Detailed Description

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

Definition at line 8 of file rcComplStatus.py.

---

Member Function Documentation

addCompletionStatus (  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.

static getCompletionStatus (  statStr   )  [static]

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.

getCompletionStatusStr (  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.

isCompletionStatus (  status   )

Check if status is already in the dictionary. Parameters: status  Completion status code Returns: True : If it is already defined. False: Otherwise

---

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

• rcComplStatus.py

---