CashFlowCalculatorgetPrincipal Method

Get the principal to be paid for a particular cashflow, as specified by cashFlowIndex.

Definition

Namespace: com.ftlabs.fisa.calc
Assembly: FISA.NET (in FISA.NET.dll) Version: 1.16.0.13 (1.16.0.13)

C#

public override double getPrincipal(
	int cashFlowIndex
)

VB

Public Overrides Function getPrincipal ( 
	cashFlowIndex As Integer
) As Double

Parameters

cashFlowIndex Int32: The cashflow index. cashFlowIndex is zero based and must be a number from 0 to getCashFlowCount() - 1.

Return Value

Double
The principal to be paid for the specified cashflow.

Implements

CalculatorgetPrincipal(Int32)

Remarks

A cashFlowIndex of 0 will access the first cashflow after the settlement date and not necessarily the first cashflow in the underlying CashFlowSchedule.