CallbackDefinition

class passengersim.callbacks.configured.CallbackDefinition(factory: Callable[[BaseModel], Any], when: 'initialize_sample' | 'begin_sample' | 'daily' | 'end_sample' | 'finalize_sample', parameters_model: type[BaseModel], version: str, output_name: str | None = None)[source]

Bases: object

Factory metadata used to validate and construct one callback per simulation.

Methods

__init__(factory, when, parameters_model, ...)

Attributes

output_name

Canonical tracer result key, or None for an ordinary callback.

factory

Construct a fresh callable from one validated options model.

when

Lifecycle hook for the constructed callback.

parameters_model

Schema used for runtime validation without changing explicit config.

version

Implementation version checked against an explicit config requirement.

factory : Callable[[BaseModel], Any]

Construct a fresh callable from one validated options model.

when : Literal['initialize_sample', 'begin_sample', 'daily', 'end_sample', 'finalize_sample']

Lifecycle hook for the constructed callback.

parameters_model : type[BaseModel]

Schema used for runtime validation without changing explicit config.

version : str

Implementation version checked against an explicit config requirement.

output_name : str | None = None

Canonical tracer result key, or None for an ordinary callback.