src.data_sources.annuity.AnnuityDataSources¶

class src.data_sources.annuity.AnnuityDataSources(projection_parameters: ProjectionParameters)¶

Root data source input package for the annuity model. This class contains all data sources (model inputs) for the annuity model.

Inheritance Diagram

Variables & Properties

`economic_scenarios`	Economic environment.
`model_points`	Annuity model points.
`mortality`	Annuity mortality assumptions.
`policyholder_behaviors`	Annuity policyholder behavior assumptions.
`product`	Annuity product assumptions.
`economic_scenario`	Current stochastic economic scenario.
`model_point`	Current model point.

Methods

`__init__`(projection_parameters)	Constructor method.
`configured_data_sources`()	Generator that cycles through each model point and economic scenario combination, setting the `model_point` and `economic_scenario` attributes as it goes.

Details

__init__(projection_parameters: ProjectionParameters)¶

Constructor method. Initializes annuity inputs package.

Parameters:: projection_parameters – Set of projection parameters that contains a resource directory.

configured_data_sources() → Generator[Self, Any, None]¶

Generator that cycles through each model point and economic scenario combination, setting the model_point and economic_scenario attributes as it goes.

Returns:: Data source, with cycling model_point and economic_scenario attributes.

economic_scenario: EconomicScenario¶: Current stochastic economic scenario.

economic_scenarios: EconomicScenarios¶: Economic environment.

model_point: ModelPoint¶: Current model point.

model_points: ModelPoints¶: Annuity model points.

mortality: Mortality¶: Annuity mortality assumptions.

path: str¶: Path to the namespace.

policyholder_behaviors: PolicyholderBehaviors¶: Annuity policyholder behavior assumptions.

product: Product¶: Annuity product assumptions.

projection_parameters: ProjectionParameters¶: Projection parameters.