ecflow.Limit

class ecflow.Limit

Bases: pybind11_object

limit provides a simple load management

i.e. by limiting the number of tasks submitted by a server. Limits are typically defined at the suite level, or defined in a separate suite, so that they can be used by multiple suites. Once a limit is defined in a suite definition, you must also assign families/tasks to use this limit. See inlimit and ecflow.InLimit

Constructor:

Limit(name,value)
   string name: the name of the limit
   int   value: The value of the limit

Usage:

limit = Limit('fast', 10)
 ...
suite = Suite('s1',
              Limit('slow',10))  # create Limit in Node constructor
suite.add_limit(limit)           # add existing limit using function

Limit.decrement(self: ecflow.Limit, arg0: SupportsInt | SupportsIndex, arg1: str) → None

used for test only

Limit.increment(self: ecflow.Limit, arg0: SupportsInt | SupportsIndex, arg1: str) → None

used for test only

Limit.limit(self: ecflow.Limit) → int

The max value of the limit as an integer

Limit.name(self: ecflow.Limit) → str

Return the limit name as string

Limit.node_paths(self: ecflow.Limit) → list

List of nodes(paths) that have consumed a limit

Limit.value(self: ecflow.Limit) → int

The limit token value as an integer