InterestPayment class

InterestPayment.py

class InterestPayment(SeriesPayment):
    """ One of a series of rate-based payments """

    def __init__(self, rate_level_model, measure, period, inception_date, payment_date,
                 interest, asset_id, name, description):
        SeriesPayment.__init__(self, inception_date, payment_date, interest,
                               asset_id, name, description)
        self.rate_level_model = rate_level_model
        self.measure = measure
        self.period = period

    def calc_level(self, market, date):
        """Returns the amount of interest to be paid on the payment date if
        the input date is before the payment date
        """
        if date <= self.payment_date:
            rate_level = self.rate_level_model.calc_level(market,
                                                          self.inception_date)
            rate = RateKit.make(rate_level, self.measure, self.period)
            accrual = rate.calc_accrual_factor(self.inception_date,
                                                    self.payment_date)
            principal = self.payment_series.principal
            notional_level = principal.calc_level(market, self.inception_date)
            return notional_level * (accrual - 1)
        else:
            return 0