CADETProcess.dynamicEvents.Event

Contents

CADETProcess.dynamicEvents.Event#

class CADETProcess.dynamicEvents.Event(name: str, event_handler: EventHandler, parameter_path: str, state: float, time: float = 0.0, indices: int | list[int] | None = None)[source]#

Defines dynamic changes of model parameters based on events.

An Event is a time-based modification to an attribute of a performer. Its execution time can depend on other Events or Durations. To handle cyclic behavior, times are computed modulo the cycle time of the EventHandler.

Attributes:
namestr

The event’s name.

event_handlerEventHandler

Object managing the performers and cycle time.

parameter_pathstr

str: Dot notation path to the target parameter within the evaluation_object.

statefloat

Return the state of the parameter event.

timefloat, default=0.0

float: Time when the event is executed.

indicesint or list, default=None

list: Indices for events that modifies only specific entries of a parameter.

Methods

add_dependency(dependency[, factor, transform])

Add a time dependency on another event.

remove_dependency(dependency)

Remove dependencies of events.

set_value(state)

Set the specified state to the associated event parameter.