Firstof

Wait for the first of a set of events.

FirstOf

Bases: Event

Wait for the first of a set of events.

Source code in src/asimpy/firstof.py

class FirstOf(Event):
    """Wait for the first 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.

        Example:

        ```
        name, value = await FirstOf(env, a=q1.get(), b=q2.get())
        ```
        """
        assert len(events) > 0
        super().__init__(env)

        self._done = False
        self._events = {}

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

    def _child_done(self, key, value, winner):
        if self._done:
            return

        self._done = True

        for evt in self._events.values():
            if evt is not winner:
                evt.cancel()

        self.succeed((key, value))

__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.	{}

Example:

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

Source code in src/asimpy/firstof.py

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

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

    Example:

    ```
    name, value = await FirstOf(env, a=q1.get(), b=q2.get())
    ```
    """
    assert len(events) > 0
    super().__init__(env)

    self._done = False
    self._events = {}

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