`Enumeration`

class Enumeration(name, enumList, flaggable=False, no_doc=False)[source]

Enumeration class intended to provide the ‘enum’ feature present in many programming languages.

The elements of the enumeration can be accessed in an “object member way” or as elements of a dictionary.

Usage:

from taurus.core.util.enumeration import Enumeration

Volkswagen = Enumeration("Volkswagen",
    ["JETTA",
     "RABBIT",
     "BEETLE",
     ("THING", 400),
     "PASSAT",
     "GOLF",
     ("CABRIO", 700),
     "EURO_VAN",
     "CLASSIC_BEETLE",
     "CLASSIC_VAN"
     ])

In the command line:

>>> my_car = Volkswagen.BEETLE
>>> homer_car = Volkswagen.PASSAT

>>> print(Volkswagen.BEETLE)
2

>>> print(Volkswagen['BEETLE'])
2

>>>print(Volkswagen.whatis(homer_car))
'PASSAT'

Import from taurus.core.util.enumeration as:

from taurus.core.util.enumeration import Enumeration

get(i)[source]: Returns the element for the given key/value

has_key(key)[source]

Determines if the enumeration contains the given key

Parameters:: key (str) – the key
Returns:: True if the key is in the enumeration or False otherswise
Return type:: bool

keys()[source]

Returns an iterable containning the valid enumeration keys

Returns:: an interable containning the valid enumeration keys
Return type:: iter<str>

whatis(value)[source]: Returns a string representation of the value in the enumeration. :param value: a valid enumeration element :return: a string representation of the given enumeration element :rtype: str

Enumeration

`Enumeration`