Search
Preparing search index...
The search index is not available
Retirement Simulator - v0.1.12
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Retirement Simulator - v0.1.12
model
Module model
Our Data Model
This needs some diagrams and explanation.
The Model Elements
Scenario
A distinct scenario to be simulated.
Snapshot
captures the state of an entire
Scenario
at a point in time.
Person
, typically individual or spouses or domestic partners.
Income
, a source of new income
Expense
, something that costs money
Asset
, something that we own. This can be something that can be potentially sold, such as a house or car, or an investment.
Liability
, something that we need to pay in the future or over time. This can be loan, or a committed expense, such as needed maintenance.
IncomeStream
, a plan combining
Income
and drawing down
Assets
, to supply funds to meet
Expenses
.
IncomeTax
, information to estimate income-based taxes that will need to be paid.
[[Text]], arbitrary user-supplied text to be used where needed.
Index
References
Asset
Asset
State
Constructor
Expense
Expense
State
G
Income
Income
State
Income
Stream
Income
Stream
State
Income
Tax
Income
Tax
State
Item
Liability
Liability
State
Monetary
Person
Scenario
Snapshot
State
State
Mixin
State
Mixin
Constructor
Text
Item
Text
Item
State
as
Asset
as
Expense
as
Income
as
Income
Stream
as
Income
Tax
as
Liability
as
Person
as
Scenario
as
Snapshot
as
Text
Item
is
Asset
is
Expense
is
Income
is
Income
Stream
is
Income
Tax
is
Liability
is
Person
is
Scenario
is
Snapshot
is
Text
Item
to
Asset
to
Expense
to
Income
to
Income
Stream
to
Income
Tax
to
Liability
to
Person
to
Scenario
to
Snapshot
to
Text
Item
References
Asset
Re-exports
Asset
Asset
State
Re-exports
AssetState
Constructor
Re-exports
Constructor
Expense
Re-exports
Expense
Expense
State
Re-exports
ExpenseState
G
Re-exports
G
Income
Re-exports
Income
Income
State
Re-exports
IncomeState
Income
Stream
Re-exports
IncomeStream
Income
Stream
State
Re-exports
IncomeStreamState
Income
Tax
Re-exports
IncomeTax
Income
Tax
State
Re-exports
IncomeTaxState
Item
Re-exports
Item
Liability
Re-exports
Liability
Liability
State
Re-exports
LiabilityState
Monetary
Re-exports
Monetary
Person
Re-exports
Person
Scenario
Re-exports
Scenario
Snapshot
Re-exports
Snapshot
State
Re-exports
State
State
Mixin
Re-exports
StateMixin
State
Mixin
Constructor
Re-exports
StateMixinConstructor
Text
Item
Re-exports
TextItem
Text
Item
State
Re-exports
TextItemState
as
Asset
Re-exports
asAsset
as
Expense
Re-exports
asExpense
as
Income
Re-exports
asIncome
as
Income
Stream
Re-exports
asIncomeStream
as
Income
Tax
Re-exports
asIncomeTax
as
Liability
Re-exports
asLiability
as
Person
Re-exports
asPerson
as
Scenario
Re-exports
asScenario
as
Snapshot
Re-exports
asSnapshot
as
Text
Item
Re-exports
asTextItem
is
Asset
Re-exports
isAsset
is
Expense
Re-exports
isExpense
is
Income
Re-exports
isIncome
is
Income
Stream
Re-exports
isIncomeStream
is
Income
Tax
Re-exports
isIncomeTax
is
Liability
Re-exports
isLiability
is
Person
Re-exports
isPerson
is
Scenario
Re-exports
isScenario
is
Snapshot
Re-exports
isSnapshot
is
Text
Item
Re-exports
isTextItem
to
Asset
Re-exports
toAsset
to
Expense
Re-exports
toExpense
to
Income
Re-exports
toIncome
to
Income
Stream
Re-exports
toIncomeStream
to
Income
Tax
Re-exports
toIncomeTax
to
Liability
Re-exports
toLiability
to
Person
Re-exports
toPerson
to
Scenario
Re-exports
toScenario
to
Snapshot
Re-exports
toSnapshot
to
Text
Item
Re-exports
toTextItem
Modules
model
Asset
Asset
State
Constructor
Expense
Expense
State
G
Income
Income
State
Income
Stream
Income
Stream
State
Income
Tax
Income
Tax
State
Item
Liability
Liability
State
Monetary
Person
Scenario
Snapshot
State
State
Mixin
State
Mixin
Constructor
Text
Item
Text
Item
State
as
Asset
as
Expense
as
Income
as
Income
Stream
as
Income
Tax
as
Liability
as
Person
as
Scenario
as
Snapshot
as
Text
Item
is
Asset
is
Expense
is
Income
is
Income
Stream
is
Income
Tax
is
Liability
is
Person
is
Scenario
is
Snapshot
is
Text
Item
to
Asset
to
Expense
to
Income
to
Income
Stream
to
Income
Tax
to
Liability
to
Person
to
Scenario
to
Snapshot
to
Text
Item
Generated using
TypeDoc
Our Data Model
This needs some diagrams and explanation.
The Model Elements