CreateAmortFixLeg Example VBA





http://www.QuantTools.com
CapeTools FIXED Legs function list
CreateAmortFixLeg function

Welcome | Documentation format | QuantTools Groups | QuantTools Categories | Licence

Key TAGs | Excel Index | API Index



Example Excel VBA Driver function. Preparing the parameters and the final function call (the result).

High level view of the code structure (resulting in the final function call to CreateAmortFixLeg() )

These are the financial QuantTools function calls that are used within the examples :





The objects generated by these functions are inter-connected in the following way :




VBA Example - CreateAmortFixLeg





    '     ##################################################################################
    '     The first function here CreateAmortFixLeg(), contains a series of
    '     function calls leading upto the main function call, the second function
    '     within this file ( CreateAmortFixLegPart() ).
    '     which contains the answer that we are looking for.

    '     The first function here is simply an example of how to construct the parameters 
    '     in order acquire either a string Key (that is to be passed to other functions) 
    '     or a computed result.

    '     If you are viewing this source code from the chm or web help file you can use the
    '     outlining features to collapse certain sections of the code for better readability. 
    '     ##################################################################################
        


' Add a reference to the CTQL_VBA_API.xla file via the Tools->Reference menu (within the VBA editor).
' This holds VBA class objects for communicating with the CTQuantToolsXL20.dll Excel Addin
' This XLA does not use COM and has access to all the financial objects created via the spreadsheet functions.


' Some global parameter in order to append to user defined keys.
' We use it here to ensure that we have unique Keys (in the case several of our examples
' use the same key-name)
' In normal use, a user defined string will be used and so this variable will be pointless.
Global nCTFIXLegsGlobal As Long
    
    
Public Function VB_EX_CreateAmortFixLeg() As String

    nCTFIXLegsGlobal = nCTFIXLegsGlobal + 1
            
    
On Error GoTo err_Generic
        
            
    

    '    EURO calendar used for holiday adjustments.

    Dim MyEuroCal As String
    MyEuroCal = _
        CALEUROPart()


    

    '    Creates a centralized valuation date object.

    Dim MyValuationDate As String
    MyValuationDate = _
        ValueDateObjPart()


    

    '    UK date calendar used within the UK stock exchange.

    Dim MyCALUKExchange As String
    MyCALUKExchange = _
        CALUKExchangePart()


    

    '    Generates a schedule of start and end dates, given the initial 
    '    start date and unadjusted final end dates.
    Dim MySchedule As String
    MySchedule = _
        MakeSchedulePart( _
        MyEuroCal)


    

    '    Creates a Deposit template which is almost identical to a Libor 
    '    Index, but without the YieldCurve information.
    Dim MyDepoTPL As String
    MyDepoTPL = _
        CreateDepoTemplatePart( _
        MyCALUKExchange, _
        MyEuroCal)


    

    '    Creates a Swap template which is almost identical to the definition 
    '    of the parameters of a swap contract, but without the swap duration, 
    '    buysell, and YieldCurve information.
    Dim MySwapTPL As String
    MySwapTPL = _
        CreateSwapTemplatePart( _
        MyEuroCal, _
        MyDepoTPL)


    

    '    Creates an amortisation object to be used within the amortisation 
    '    fixed and floating rate leg objects.
    Dim MyCreateAmortObj As String
    MyCreateAmortObj = _
        CreateAmortObjPart( _
        MySchedule)


    

    '    Creates a yield curve using market rates (No cross-currency 
    '    Swaps).
    Dim MyYCInterpOnDCF As String
    MyYCInterpOnDCF = _
        MKTYC_DPart( _
        MyValuationDate, _
        MyDepoTPL, _
        MySwapTPL)


    

    '    Creates a SABR curve to model the dynamics of the volatility 
    '    curve (smile).
    Dim MySABRVolCurve As String
    MySABRVolCurve = _
        SABRVolCurvePart( _
        MyValuationDate, _
        MyDepoTPL, _
        MySwapTPL)


    

    '    Creates a market object which is an aggregate of interest rate 
    '    market objects (Discounting curve and Interest rate volatility 
    '    curve (volcurve)).
    Dim MyMarket As String
    MyMarket = _
        CreateMKTPart( _
        MyYCInterpOnDCF, _
        MySABRVolCurve)


    

    '    Creates an amortised fixed rate leg.
    Dim MyCreateAmortFixLeg As String
    MyCreateAmortFixLeg = _
        CreateAmortFixLegPart( _
        MyCreateAmortObj, _
        MyMarket)

    ' This is the result we are looking for.
    VB_EX_CreateAmortFixLeg = MyCreateAmortFixLeg

            
    
    Exit Function
err_Generic:
    MsgBox "Error: " & Err.Number & vbCrLf & Err.Description    
    
            
End Function                
        


' ///////////////////////////////////////////////////////////////////

Private Function CreateAmortFixLegPart( _
    MyCreateAmortObj As String, _                
    MyMarket As String) As String


    
        '  Create example range for parameter CreateAmortFixLeg_Coupon

        ' Column vector of 20 rows (indexed from 0, highest index of 19)
        Dim CreateAmortFixLeg_Coupon(19, 0) As Variant
                
        CreateAmortFixLeg_Coupon(0, 0) = 0.05
        CreateAmortFixLeg_Coupon(1, 0) = 0.05
        CreateAmortFixLeg_Coupon(2, 0) = 0.05
        CreateAmortFixLeg_Coupon(3, 0) = 0.05
        CreateAmortFixLeg_Coupon(4, 0) = 0.05
        CreateAmortFixLeg_Coupon(5, 0) = 0.05
        CreateAmortFixLeg_Coupon(6, 0) = 0.05
        CreateAmortFixLeg_Coupon(7, 0) = 0.05
        CreateAmortFixLeg_Coupon(8, 0) = 0.05
        CreateAmortFixLeg_Coupon(9, 0) = 0.05
        CreateAmortFixLeg_Coupon(10, 0) = 0.05
        CreateAmortFixLeg_Coupon(11, 0) = 0.05
        CreateAmortFixLeg_Coupon(12, 0) = 0.05
        CreateAmortFixLeg_Coupon(13, 0) = 0.05
        CreateAmortFixLeg_Coupon(14, 0) = 0.05
        CreateAmortFixLeg_Coupon(15, 0) = 0.05
        CreateAmortFixLeg_Coupon(16, 0) = 0.05
        CreateAmortFixLeg_Coupon(17, 0) = 0.05
        CreateAmortFixLeg_Coupon(18, 0) = 0.05
        CreateAmortFixLeg_Coupon(19, 0) = 0.05
        
            



    '    Key value to use as a handle for the created object
        Dim MyCreateAmortFixLeg As String
        MyCreateAmortFixLeg = "MyCreateAmortFixLeg" & "_" & CStr(nCTFIXLegsGlobal)


    '    When creating this object for the first time, set this parameter 
    '    to a positive value.
        Dim Reload As Long
        Reload = 1


    '    Whether you would like to PAY or REC this leg.
        Dim PayRec As String
        PayRec = "PAY"


    '    A positive factor value you wish to multiply the Floating-Reset 
    '    Rate/Fixed-Coupon Rate by (Usually 1).
        Dim Gearing As Long
        Gearing = 1


    '    Currency of the Notional amount.
        Dim Ccy As String
        Ccy = "EUR"


    '    Payment Business Day Convention.
        Dim BusDayConv As String
        BusDayConv = "ModifiedFollowing"


    '    Payment DayCounter.
        Dim DayCount As String
        DayCount = "ACT365F"


    '    Whether you wish to exchange the principal amount(s) at the 
    '    start and termination of the leg contract.
        Dim ExchangePrincipal As Boolean
        ExchangePrincipal = false

                    
    '  Excel function call is : "CT.LEG.CreateAmortFixLeg()"

    '    Creates an amortised fixed rate leg.
        Dim rCreateAmortFixLeg As String 
        
        ' We call the CreateCTFIXLegs() function via the CTQL module exposed from the CTQL_VBA_API.xla addin.
        Dim oCTFIXLegs As CTFIXLegs
        Set oCTFIXLegs = CTQL.CreateCTFIXLegs()
    
        rCreateAmortFixLeg = oCTFIXLegs.CreateAmortFixLeg( _
                MyCreateAmortFixLeg, _
                Reload, _
                PayRec, _
                Gearing, _
                MyCreateAmortObj, _
                Ccy, _
                BusDayConv, _
                DayCount, _
                CreateAmortFixLeg_Coupon, _
                ExchangePrincipal, _
                MyMarket)


    CreateAmortFixLegPart = rCreateAmortFixLeg
    
End Function                        








Copyright (c) 2003-2007 CapeTools - All Rights Reserved.