CreateAmortObj

High level graphic of CreateAmortObj() function with parameters. Blue square node is the actual function with the parameters ordered.

1. Key parameter
   
   
   Key value to use as a handle for the created object
2. Reload parameter
   
   
   When creating this object for the first time, set this parameter to a positive value. Within Excel, when re-computing a worksheet where you do not wish to recreate the object, set this parameter to zero (0).
3. Notional parameter
   
   
   Initial positive notional amount. Must be a single value. Amortisation function will control the generation of notional for following cash flows.
4. FinalNot parameter
   
   
   Final positive notional amount. Enter a value of zero (0) if you wish to amortise to zero except for the cases where the AmortMethod is either 'DB' or 'DDBExact'. You cannot specify an ending Notional of zero in these latter two amortisation methods.
5. PrincipalPayments parameter
   
   
   Whether you wish to include principal payments that are paid to the holder of this contract during the life of the leg contract. In the case of amortised legs, this should generally be set to true.
6. AmortMethod parameter
   
   
   Amortisation method to use. You can choose one of the following : 'Linear', 'Amortise', 'SLN', 'SYD', 'DB', 'DDBExact' or 'GDB'.
7. AmortRate parameter
   
   
   Amortisation rate to use. Needed by the 'Linear', 'Amortise' and 'GDB' amortisation methods (indicated by the AmortMethod parameter). This is an annual rate in decimal notation.
8. AmortRepeatNot parameter
   
   
   The number of times you would like to repeat the Notional amounts computed (normally 1).
9. ScheduleKey parameter
   
   
   Schedule Key to an already generated schedule object.

String CTUtils.CreateAmortObj( _
String Key, _
Long Reload, _
Double Notional, _
Double FinalNot, _
Boolean PrincipalPayments, _
AmortEnum AmortMethod, _
Double AmortRate, _
Long AmortRepeatNot, _
String ScheduleKey)

=CT.UTIL.CreateAmortObj(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel Numeric Cell Notional,
Excel Numeric Cell FinalNot,
Excel Boolean Value Cell PrincipalPayments,
Excel String Cell AmortMethod,
Excel Numeric Cell AmortRate,
Excel Numeric Cell AmortRepeatNot,
Excel String Cell ScheduleKey)

static std::string CreateAmortObj(
std::string Key,
long Reload,
double Notional,
double FinalNot,
bool PrincipalPayments,
AmortEnum AmortMethod,
double AmortRate,
long AmortRepeatNot,
std::string ScheduleKey);

System.String CTUtilsSA.CreateAmortObj(
System.String Key,
System.Int32 Reload,
System.Double Notional,
System.Double FinalNot,
System.Boolean PrincipalPayments,
CTIEnums.AmortEnum AmortMethod,
System.Double AmortRate,
System.Int32 AmortRepeatNot,
System.String ScheduleKey);

• CALEURO() ( CT.QL.Curves20 )
• MakeSchedule() ( CT.QL.Curves20 )
• CreateAmortObj() ( CT.QL.Utils20 )

• Example VB.NET Driver function. Preparing the parameters and the final function call (the result).
• Example C# Driver function. Preparing the parameters, sub-function calls and the final function call (the result).
• Example C++.NET Driver function. Preparing the parameters and the final function call (the result).
• Example J# Driver function. Preparing the parameters and the final function call (the result).

• Example Visual Basic 6 Driver function. Preparing the parameters and the final function call (the result).
• Example Excel VBA Driver function. Preparing the parameters and the final function call (the result).
• Example C++ Driver function. Preparing the parameters and the final function call (the result).
• Example Java Driver function. Preparing the parameters and the final function call (the result).