Enumerate::Enumerate Class Reference

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

List of all members.

Public Member Functions
def	__call__
def	__init__
def	__setattr__
def	isValidKey
def	isValidValue
def	keys
def	valueToKey
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

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

Definition at line 13 of file Enumerate.py.

                                                                        :
        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

def Enumerate::Enumerate::__call__	(		self,
			key
	)

Definition at line 63 of file Enumerate.py.

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

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 53 of file Enumerate.py.

                                       :
        """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)

def Enumerate::Enumerate::isValidKey	(		self,
			key
	)

Returns true if this value is a valid enum key

Definition at line 36 of file Enumerate.py.

                              :
        """ Returns true if this value is a valid enum key"""
        return self.__dict__.has_key (key)

def Enumerate::Enumerate::isValidValue	(		self,
			value
	)

Returns true if this value is a valid enum value

Definition at line 31 of file Enumerate.py.

                                  :
        """ Returns true if this value is a valid enum value"""
        return self._valueDict.has_key (value)

def Enumerate::Enumerate::keys

(

self

)

Returns copy of valid keys 

Definition at line 46 of file Enumerate.py.

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

def Enumerate::Enumerate::valueToKey	(		self,
			value
	)

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

Definition at line 41 of file Enumerate.py.

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

---

Member Data Documentation

Enumerate::Enumerate::_keys [private]

Definition at line 13 of file Enumerate.py.

Enumerate::Enumerate::_valueDict [private]

Definition at line 13 of file Enumerate.py.