cosapp.ports.enum

Classes

PortType(value[, names, module, qualname, ...])	Enumeration for the port type.
RangeType(value[, names, module, qualname, ...])	Enumeration for the type of valid_range and limit of variable.
Scope(value[, names, module, qualname, ...])	Enumeration of variable scope.
Validity(value[, names, module, qualname, ...])	Enumeration for the validity of a variable value.

class cosapp.ports.enum.PortType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enumeration for the port type.

A Port can be either IN or OUT depending if its variables are needed for calculating the System (IN) or results of the calculation (OUT).

IN = 'in'

OUT = 'out'

class cosapp.ports.enum.RangeType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Enumeration for the type of valid_range and limit of variable.

If the value is a (lower, upper) tuple, type is VALUE. If the value is a tuple of tuples, type is TUPLE. Tf the value is None, type is NONE.

NONE = 0

TUPLE = 2

VALUE = 1

class cosapp.ports.enum.Scope(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Enumeration of variable scope.

PRIVATE = 1

PROTECTED = 0

PUBLIC = -1

class cosapp.ports.enum.Validity(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: IntEnum

Enumeration for the validity of a variable value.

A valid variable value is OK. If the value is outside the limits, status is ERROR. If the value falls between the validity range and the limits, status is WARNING.

ERROR = -1

OK = 1

WARNING = 0