jupedsim_scenarios.agent_parameters#
Per-agent parameter fields, their settings keys, bounds and overrides.
A spawn area may carry agent_parameter_overrides, shaped
{"<model_type>": {"<jupedsim_field>": <number>}}. Only the entry for the
active model applies; absent means the area inherits the global settings.
Attributes#
Exceptions#
A spawn area's agent parameters are invalid; the run does not start. |
Classes#
Closed or open interval; |
Functions#
|
Return the area's overrides for |
|
Labels of the spawn areas whose |
|
Message for a changed default that overriding spawn areas ignore. |
|
Map each settings key of |
|
Reject invalid agent parameters of every spawn area before placement. |
Module Contents#
- exception AgentParameterError[source]#
Bases:
ValueErrorA spawn area’s agent parameters are invalid; the run does not start.
- active_overrides(params: dict, model_type: str) dict[str, float][source]#
Return the area’s overrides for
model_type;{}when absent.
- overriding_area_labels(distributions, model_type: str, field: str) list[str][source]#
Labels of the spawn areas whose
model_typeoverrides setfield.
- precedence_warning(settings_key: str, field: str, labels: list[str]) str[source]#
Message for a changed default that overriding spawn areas ignore.
- settings_key_fields(model_type: str) dict[str, str][source]#
Map each settings key of
model_typeto the field it sets.
- validate_agent_parameters(data: dict, model_type: str, global_params) None[source]#
Reject invalid agent parameters of every spawn area before placement.
Covers explicit overrides and inherited settings alike, because each per-agent field is resolved and its effective value is bounds-checked. Raises
AgentParameterErrornaming the area, model and field.