Enumerate.Enumerate Class Reference

Note: Please do not use or modify any data or functions with a leading underscore. More...

Inheritance diagram for Enumerate.Enumerate:

Public Member Functions
def	__call__ (self, key)
def	__init__ (self, names, prefix='', asInt=False, intOffset=0)
def	__setattr__ (self, name, value)
def	isValidKey (self, key)
def	isValidValue (self, value)
def	keys (self)
def	valueToKey (self, value)

Private Attributes
	_keys
	_valueDict

Detailed Description

Note: Please do not use or modify any data or functions with a leading underscore.

If you "mess" with the internal structure, the classes may not function as intended.

Similar to C++'s 'enum', but with a few extra toys.  Takes a
string with spaces in between the different 'enum' names (keys).
If 'asInt' is true, then values will be integers (useful for array
indicies).  Once created, the enum values can not be changed.

Definition at line 7 of file Enumerate.py.

Constructor & Destructor Documentation

__init__()

def Enumerate.Enumerate.__init__	(		self,
			names,
			prefix = '',
			asInt = False,
			intOffset = 0
	)

Definition at line 13 of file Enumerate.py.

    def __init__(self, names, prefix = '', asInt = False, intOffset = 0):
        biggest = smallest = ""
        self._keys = []
        self._valueDict = {}
        for count, name in enumerate (names.split()) :
            # make sure we don't already have this key
            if self.isValidKey (name):
                raise RuntimeError("You can not duplicate Enum Names '%s'" % name)
            # set the value using the base class
            key = "%s_%s" % (prefix, name)
            if asInt:
                key = count + intOffset
            object.__setattr__ (self, name, key)
            self._valueDict[key] = name
            self._keys.append (name)
 
 

Member Function Documentation

__call__()

def Enumerate.Enumerate.__call__	(		self,
			key
	)

Definition at line 62 of file Enumerate.py.

    def __call__ (self, key):
        return self.__dict__.get (key, None)
 

__setattr__()

def Enumerate.Enumerate.__setattr__	(		self,
			name,
			value
	)

Lets me set internal values, but throws an error if any of
the enum values are changed

Definition at line 52 of file Enumerate.py.

    def __setattr__ (self, name, value):
        """Lets me set internal values, but throws an error if any of
        the enum values are changed"""
        if not name.startswith ("_"):
            # Once it's set, you can't change the values
            raise RuntimeError("You can not modify Enum values.")
        else:
            object.__setattr__ (self, name, value)
 
 

Referenced by GenObject.GenObject.setValue().

isValidKey()

def Enumerate.Enumerate.isValidKey	(		self,
			key
	)

Returns true if this value is a valid enum key

Definition at line 35 of file Enumerate.py.

    def isValidKey (self, key):
        """ Returns true if this value is a valid enum key"""
        return key in self.__dict__
 
 

isValidValue()

def Enumerate.Enumerate.isValidValue	(		self,
			value
	)

Returns true if this value is a valid enum value

Definition at line 30 of file Enumerate.py.

    def isValidValue (self, value):
        """ Returns true if this value is a valid enum value"""
        return value in self._valueDict
 
 

References Enumerate.Enumerate._valueDict.

keys()

def Enumerate.Enumerate.keys

(

self

)

Returns copy of valid keys 

Definition at line 45 of file Enumerate.py.

    def keys (self):
        """ Returns copy of valid keys """
        # since this is a list, return a copy of it instead of the
        # list itself
        return self._keys [:]
 
 

References Enumerate.Enumerate._keys.

Referenced by psClasses.queueList.__init__(), psClasses.queueList.smallestQueue(), and psClasses.queueList.thinerQueue().

valueToKey()

def Enumerate.Enumerate.valueToKey	(		self,
			value
	)

Returns the key (if it exists) for a given enum value

Definition at line 40 of file Enumerate.py.

    def valueToKey (self, value):
        """ Returns the key (if it exists) for a given enum value"""
        return self._valueDict.get (value, None)
 
 

References Enumerate.Enumerate._valueDict.

Member Data Documentation

_keys

Enumerate.Enumerate._keys

private

Definition at line 15 of file Enumerate.py.

Referenced by Enumerate.Enumerate.keys().

_valueDict

Enumerate.Enumerate._valueDict

private

Definition at line 16 of file Enumerate.py.

Referenced by Enumerate.Enumerate.isValidValue(), and Enumerate.Enumerate.valueToKey().