Allof

Wait for all events in a set to complete.

AllOf

Bases: Event

Wait for all of a set of events.

Source code in src/asimpy/allof.py

class AllOf(Event):
    """Wait for all of a set of events."""

    def __init__(self, env: Environment, **events: Any):
        """
        Construct new collective wait.

        Args:
            env: simulation environment.
            events: name=thing items to wait for.

        Raises:
            ValueError: if no events provided.

        Example:

        ```
        name, value = await AllOf(env, a=q1.get(), b=q2.get())
        ```
        """
        _validate(len(events) > 0, "AllOf requires at least one event")
        super().__init__(env)

        self._events = {}
        self._results = {}

        for key, obj in events.items():
            evt = _ensure_event(env, obj)
            self._events[key] = evt
            evt._add_waiter(_AllOfWatcher(self, key))

    def _child_done(self, key, value):
        self._results[key] = value
        if len(self._results) == len(self._events):
            self.succeed(self._results)

__init__(env, **events)

Construct new collective wait.

Parameters:

Name	Type	Description	Default
env	Environment	simulation environment.	required
events	Any	name=thing items to wait for.	{}

Raises:

Type	Description
ValueError	if no events provided.

Example:

name, value = await AllOf(env, a=q1.get(), b=q2.get())

Source code in src/asimpy/allof.py

def __init__(self, env: Environment, **events: Any):
    """
    Construct new collective wait.

    Args:
        env: simulation environment.
        events: name=thing items to wait for.

    Raises:
        ValueError: if no events provided.

    Example:

    ```
    name, value = await AllOf(env, a=q1.get(), b=q2.get())
    ```
    """
    _validate(len(events) > 0, "AllOf requires at least one event")
    super().__init__(env)

    self._events = {}
    self._results = {}

    for key, obj in events.items():
        evt = _ensure_event(env, obj)
        self._events[key] = evt
        evt._add_waiter(_AllOfWatcher(self, key))