VaccinationDimension

class dynode.config.dimension.VaccinationDimension(max_ordinal_vaccinations: int, seasonal_vaccination: bool = False, name: Annotated[str, BeforeValidator(func=_verify_name, json_schema_input_type=PydanticUndefined)] = 'vax')

Bases: Dimension

A vaccination dimension of a compartment, supporting ordinal (and optionally seasonal) vaccinations.

__init__(max_ordinal_vaccinations: int, seasonal_vaccination: bool = False, name: Annotated[str, BeforeValidator(func=_verify_name, json_schema_input_type=PydanticUndefined)] = 'vax')

Specify a vaccination dimension with some ordinal doses and optional seasonal dose.

Methods

__init__(max_ordinal_vaccinations[, ...])

Specify a vaccination dimension with some ordinal doses and optional seasonal dose.

Attributes

max_shots	Maximum number of tracked vaccinations in the dimension.
model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
seasonal_vaccination
name
bins

seasonal_vaccination: bool

property max_shots: int

Maximum number of tracked vaccinations in the dimension.

Additional shots do not increase the count.

_abc_impl = <_abc._abc_data object>

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].