TkUnits#

module wntr.epanet.msx.enums

class TkUnits[source]#

Bases: IntEnum

Position for units used in EPANET-MSX.

Warning

These enum values start with 0.

Enum Members

The following enum names are defined, and, if using the get() method, then they are case insensitive and can be optionally prefixed with “MSX_”.

LENGTH_UNITS

the length unit index

DIAM_UNITS

the diameter unit index

AREA_UNITS

the area unit index

VOL_UNITS

the volume unit index

FLOW_UNITS

the flow unit index

CONC_UNITS

the concentration unit index

RATE_UNITS

the rate unit index
classmethod get(value, *, prefix='MSX_', abbrev=False, allow_none=True)#

Get the proper enum based on the name or value of the argument.

See add_get() for details on how this function works.

Parameters:

  • value (Union[str, int, Enum]) – the value to be checked, if it is an Enum, then the name will be used

  • prefix (str, optional) – a prefix to strip from the beginning of value, default blank or set by decorator

  • abbrev (bool, optional) – whether to try a single-letter version of value, default False or set by decorator

  • allow_none (bool, optional) – passing None will return None, otherwise will raise TypeError, default True or set by decorator

Returns:

the enum member that corresponds to the name or value passed in

Return type:

Enum

Raises:
__init__(*args, **kwds)#
__new__(value)#
as_integer_ratio()#

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)
bit_count()#

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3
bit_length()#

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6
conjugate()#

Returns self, the complex conjugate of any int.

classmethod from_bytes(bytes, byteorder='big', *, signed=False)#

Return the integer represented by the given array of bytes.

bytes

Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value. Default is to use ‘big’.

signed

Indicates whether two’s complement is used to represent the integer.

to_bytes(length=1, byteorder='big', *, signed=False)#

Return an array of bytes representing an integer.

length

Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. Default is length 1.

byteorder

The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value. Default is to use ‘big’.

signed

Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

AREA_UNITS = 2#

the area unit index

CONC_UNITS = 5#

the concentration unit index

DIAM_UNITS = 1#

the diameter unit index

FLOW_UNITS = 4#

the flow unit index

LENGTH_UNITS = 0#

the length unit index

MAX_UNIT_TYPES = 7#
RATE_UNITS = 6#

the rate unit index

VOL_UNITS = 3#

the volume unit index

denominator#

the denominator of a rational number in lowest terms

imag#

the imaginary part of a complex number

numerator#

the numerator of a rational number in lowest terms

real#

the real part of a complex number