Mondaic

salvus.project.components.event_component

salvus.project.components.event_component salvus project components event_component

The event component.

Classes

EventComponent

class EventComponent(builtins.object):
    def __init__(self, project: Project, path: pathlib.Path): ...

Project subclass handling all things related to the events.

Parameters
  • project Project — The project for the component.
  • path pathlib.Path — The event path in the project.
Methods
add()
def add(
    self,
    e: Event | EventCollection | EventBlockCollection | str | pathlib.Path,
    check_consistency_with_domain: bool = True,
) -> None: ...

Adds an event or event collection object to the project.

Might not be supported for all event backends and not every backend can add all types of event representations.

Parameters
  • e Event | EventCollection | EventBlockCollection | str | pathlib.Path — Event, EventCollection, or an event block representation to be added.
  • check_consistency_with_domain bool — Ensure that the entity is compatible with the simulation domain.
Returns None
delete()
def delete(self, event_name: str) -> None: ...

Delete an event.

Might not be supported for all backends.

Fully delete all data and what not from the chosen event. Be careful as there is no other prompt and calling this function will irrevocably delete all data for the chosen event.

Parameters
  • event_name str — Name of the event to be deleted.
Returns None
exists()
def exists(self, event_name: str) -> bool: ...

Determine if the specified event exists within the project.

Parameters
  • event_name str — The name of the event.
Returns bool — True or False.
get()
def get(self, event_name: str) -> Event: ...

Get an event.

Parameters
  • event_name str — Name of the event.
Returns Event
get_all()
def get_all(self) -> EventCollection: ...

Get all events.

Returns EventCollection
get_many()
def get_many(
    self, event_names: typing.Sequence[str]
) -> builtins.list[Event]: ...

Get many events at once.

Prefer this over calling get() in a loop - depending on the backend a single event lookup can be as expensive as retrieving the whole batch.

Parameters
  • event_names typing.Sequence[str] — Names of the events, in the desired order.
Returns builtins.list[Event]
list()
def list(self) -> list[str]: ...

Get a list of all events.

Returns list[str]
update()
def update(self, e: Event) -> None: ...

Special function updating a single event.

This is different deleting and re-adding an event in that all associated data will be retained. Please be aware of of the consequences and that it is not always advisable to change existing data in a project.

Parameters
  • e Event — Event to be updated.
Returns None

Used in tutorials