src.data_sources.annuity.model_points.model_point.riders.gmwb.Gmwb

class src.data_sources.annuity.model_points.model_point.riders.gmwb.Gmwb(data: Dict)

Data source for a Guaranteed Minimum Withdrawal Benefit (GMWB) rider.

Inheritance Diagram

Variables & Properties

benefit_base	GMWB Benefit Base, typically used as a basis for GMWB withdrawals.
first_withdrawal_date	Withdrawal program start date.
rider_name	Human-readable rider name.
rider_type	Rider type, used to indicate what kind of rider this is.

Methods

__init__(data)

Constructor method.

Details

__init__(data: Dict)

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

Parameters:

data – Data for a GMWB rider.

property benefit_base: float

GMWB Benefit Base, typically used as a basis for GMWB withdrawals.

Returns:

GMWB Benefit Base.

cache: DataFrame

Internal cache, populated at runtime.

property first_withdrawal_date: date | None

Withdrawal program start date. If this policy has no planned withdrawal program, return None.

Returns:

Withdrawal program start date.

property rider_name: str

Human-readable rider name.

Returns:

Rider name.

property rider_type: str

Rider type, used to indicate what kind of rider this is.

Returns:

Rider type.