org.drip.portfolioconstruction.alm

Class NetLiabilityCashFlow

java.lang.Object

org.drip.portfolioconstruction.alm.NetLiabilityCashFlow

public class NetLiabilityCashFlow
extends java.lang.Object

NetLiabilityCashFlow holds the Investor Time Snap's Singular Liability Flow Details.

Author:

Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor and Description
NetLiabilityCashFlow(double dblAge, boolean bIsRetired, boolean bIsAlive, double dblHorizon, double dblAfterTaxIncome, double dblWorkingAgeIncome, double dblPensionBenefits, double dblBasicConsumption, double dblWorkingAgeIncomeDF, double dblPensionBenefitsDF, double dblBasicConsumptionDF) NetLiabilityCashFlow Constructor

Method Summary

Modifier and Type	Method and Description
double	afterTaxIncome() Retrieve the Basic After-Tax Income
double	age() Retrieve the Investor Age
double	basicConsumption() Retrieve the Investor Basic Consumption
double	basicConsumptionDF() Retrieve the Investor Basic Consumption Discount Factor
double	horizon() Retrieve the Snapshot's Investment Horizon
boolean	isAlive() Retrieve the "Is Alive" Indicator Flag
boolean	isRetired() Retrieve the Retirement Indicator Flag
double	pensionBenefits() Retrieve the Investor Pension Benefits
double	pensionBenefitsDF() Retrieve the Investor Pension Benefits Discount Factor
double	workingAgeIncome() Retrieve the Investor Working Age Income
double	workingAgeIncomeDF() Retrieve the Investor Working Age Income Discount Factor

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NetLiabilityCashFlow

public NetLiabilityCashFlow(double dblAge,
                            boolean bIsRetired,
                            boolean bIsAlive,
                            double dblHorizon,
                            double dblAfterTaxIncome,
                            double dblWorkingAgeIncome,
                            double dblPensionBenefits,
                            double dblBasicConsumption,
                            double dblWorkingAgeIncomeDF,
                            double dblPensionBenefitsDF,
                            double dblBasicConsumptionDF)
                     throws java.lang.Exception

NetLiabilityCashFlow Constructor

Parameters:

dblAge - The Investor Age

bIsRetired - The Retirement Indicator Flag

bIsAlive - The "Is Alive" Indicator Flag

dblHorizon - The Snapshot's Investment Horizon

dblAfterTaxIncome - The Basic After-Tax Income

dblWorkingAgeIncome - The Investor Working Age Income

dblPensionBenefits - The Investor Pension Benefits

dblBasicConsumption - The Investor Basic Consumption

dblWorkingAgeIncomeDF - The Investor Working Age Income Discount Factor

dblPensionBenefitsDF - The Investor Pension Benefits Discount Factor

dblBasicConsumptionDF - The Investor Basic Consumption Discount Factor

Throws:

java.lang.Exception - Thrown if the Inputs are invalid

Method Detail

age

public double age()

Retrieve the Investor Age

Returns:

The Investor Age

isRetired

public boolean isRetired()

Retrieve the Retirement Indicator Flag

Returns:

The Retirement Indicator Flag

isAlive

public boolean isAlive()

Retrieve the "Is Alive" Indicator Flag

Returns:

The "Is Alive" Indicator Flag

horizon

public double horizon()

Retrieve the Snapshot's Investment Horizon

Returns:

The Snapshot's Investment Horizon

afterTaxIncome

public double afterTaxIncome()

Retrieve the Basic After-Tax Income

Returns:

The Basic After-Tax Income

workingAgeIncome

public double workingAgeIncome()

Retrieve the Investor Working Age Income

Returns:

The Investor Working Age Income

pensionBenefits

public double pensionBenefits()

Retrieve the Investor Pension Benefits

Returns:

The Investor Pension Benefits

basicConsumption

public double basicConsumption()

Retrieve the Investor Basic Consumption

Returns:

The Investor Basic Consumption

workingAgeIncomeDF

public double workingAgeIncomeDF()

Retrieve the Investor Working Age Income Discount Factor

Returns:

The Investor Working Age Income Discount Factor

pensionBenefitsDF

public double pensionBenefitsDF()

Retrieve the Investor Pension Benefits Discount Factor

Returns:

The Investor Pension Benefits Discount Factor

basicConsumptionDF

public double basicConsumptionDF()

Retrieve the Investor Basic Consumption Discount Factor

Returns:

The Investor Basic Consumption Discount Factor