src.data_sources.annuity.model_points.model_point.ModelPoint

class src.data_sources.annuity.model_points.model_point.ModelPoint(data: Series)

Data source for a single annuity model point. Contains nested data sources for dynamic parts of a model point.

Inheritance Diagram

Variables & Properties

id	Unique identifier for this model point.
issue_date	Policy issue date.
product_name	Human-readable product name.
product_type	Product type enum that denotes what kind of product this model point is.
annuitants	Annuitants associated with this model point.
riders	Riders associated with this model point.
accounts	Accounts associated with this model point.

Methods

__init__(data)

Constructor method.

Details

__init__(data: Series)

Constructor method. Initializes a model point based on data within an annuity model point file.

Parameters:

data – Model point data.

accounts: Accounts

Accounts associated with this model point.

annuitants: Annuitants

Annuitants associated with this model point.

cache: DataFrame

Internal cache, populated at runtime.

property id: str

Unique identifier for this model point. This could be a Policy Number, integer, GUID, or any other unique code.

Returns:

Model point ID.

property issue_date: date

Policy issue date.

Returns:

Issue date.

property product_name: str

Human-readable product name.

Returns:

Friendly product name.

property product_type: ProductType

Product type enum that denotes what kind of product this model point is. For example, Variable Annuity or Universal Life.

Returns:

Product type.

riders: Riders

Riders associated with this model point.