Class PersonState

Hierarchy

IPerson<this> & { type: "person" } & ItemMethods<"person", this> & { survivalProbabilities: Probability[] } & { age: any } & { id: string; prettyName: string; scenario: ItemImpl<"scenario">; temporal: Temporal<ItemImpl<"person">> } & IState<"person", this> & { [toStringTag]: string }
- PersonState

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PersonState(row: ItemImpl<"person">, scenario: IFScenario, state: IItemState<"person"> & { age: Age; expected: number; mortality: Probability; n: number; survival: Probability }): PersonState

Overrides StateMixin(Person).constructor
- Defined in src/model/person.ts:99
Parameters
- row: ItemImpl<"person">
- scenario: IFScenario
- state: IItemState<"person"> & { age: Age; expected: number; mortality: Probability; n: number; survival: Probability }
Returns PersonState

Properties

[toStringTag]

[toStringTag]: string

Readonly birth

birth: Date

For actuarial and Social Security calculation purposes.

categories

categories: Category[]

Optional Readonly end

end: boolean

id

id: string

Readonly item

item: RowType<"person">

Readonly name

name: string

Optional notes

notes: string

prettyName

prettyName: string

Readonly scenario

scenario: IScenario & { type: "scenario" } & ItemMethods<"scenario"> & { asset_list: IFAsset[]; assets: NamedIndex<IFAsset>; dateRange: [start: Date, end: Date]; expense_list: IFExpense[]; expenses: NamedIndex<IFExpense>; incomeStream_list: IFIncomeStream[]; incomeStreams: NamedIndex<IFIncomeStream>; income_list: IFIncome[]; incomes: NamedIndex<IFIncome>; liabilities: NamedIndex<IFLiability>; liability_list: IFLiability[]; people: NamedIndex<IFPerson>; person_list: IFPerson[]; scenario: IFScenario; spouse1: IFPerson; spouse2: null | IFPerson; tax_list: IFIncomeTax[]; taxes: NamedIndex<IFIncomeTax>; text_list: IFText[]; texts: NamedIndex<IFText> } & { findItem: any; findItems: any; findText: any } & { id: string; prettyName: string; scenario: ItemImpl<"scenario">; temporal: Temporal<ItemImpl<"scenario">> }

scenarios

scenarios: string[]

sex

sex: Sex

For actuarial purposes.

sort

sort: number

Readonly start

start: Date

Readonly state

state: IItemState<"person"> & { age: Age; expected: number; mortality: Probability; n: number; survival: Probability }

Readonly survivalProbabilities

survivalProbabilities: Probability[]

temporal

temporal: Temporal<TemporalItem<"person">> & Temporal<ItemImpl<"person">>

Readonly type

type: "person"

Methods

age

age(date: Date): Age
age(year: Year): Age

Inherited from StateMixin(Person).age
- Defined in src/types.ts:100
Get the fractional age on the date of interest.

Parameters
- date: Date
  
  the date of interest.
Returns Age
Inherited from StateMixin(Person).age
- Defined in src/types.ts:105
Obtain the integer age reached on the birthday occurring in the specified year.

Parameters
- year: Year
  
  Year as an integer
Returns Age

hasCategory

hasCategory(category: Category): boolean

Inherited from StateMixin(Person).hasCategory
- Defined in src/types.ts:52
Parameters
- category: Category
Returns boolean

inScenario

inScenario(scenario: string): boolean

Inherited from StateMixin(Person).inScenario
- Defined in src/types.ts:53
Parameters
- scenario: string
Returns boolean

states

states(start: CalendarStep): Generator<IItemState<"person"> & { age: Age; expected: number; mortality: Probability; n: number; survival: Probability }, any, IItemState<"person"> & { age: Age; expected: number; mortality: Probability; n: number; survival: Probability }>

Inherited from StateMixin(Person).states
- Defined in src/types.ts:54
Parameters
- start: CalendarStep
Returns Generator<IItemState<"person"> & { age: Age; expected: number; mortality: Probability; n: number; survival: Probability }, any, IItemState<"person"> & { age: Age; expected: number; mortality: Probability; n: number; survival: Probability }>

Generated using TypeDoc