Enumerated

class Cauldron.types.Enumerated[source] [edit on github]

Bases: Cauldron.types.Integer

An enumerated keyword, which uses an integer as the underlying datatype.

Attributes Summary

KTL_ALIASES
KTL_DISPATCHER
KTL_REGISTERED
KTL_TYPE
keys The keys available.
maximum
minimum

Methods Summary

cast(value) Cast the enumerated integer to the binary representation.
check(value) Check the value
increment([amount]) Increment the integer value.
postread(value) Translate the value for python binary return.
prewrite(value)
translate(value) Translate to the enumerated binary value

Attributes Documentation

KTL_ALIASES = ()
KTL_DISPATCHER = None
KTL_REGISTERED = False
KTL_TYPE = 'enumerated'
keys

The keys available.

maximum = 2147483647
minimum = -2147483648

Methods Documentation

cast(value)[source] [edit on github]

Cast the enumerated integer to the binary representation.

check(value)[source] [edit on github]

Check the value

increment(amount=1) [edit on github]

Increment the integer value.

postread(value) [edit on github]

Translate the value for python binary return.

prewrite(value)[source] [edit on github]
translate(value)[source] [edit on github]

Translate to the enumerated binary value