CreateStructure Example VBA





http://www.QuantTools.com
CapeTools Query Legs function list
CreateStructure 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 CreateStructure() )

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 - CreateStructure





    '     ##################################################################################
    '     The first function here CreateStructure(), contains a series of
    '     function calls leading upto the main function call, the second function
    '     within this file ( CreateStructurePart() ).
    '     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 nCTQryLegsGlobal As Long
    
    
Public Function VB_EX_CreateStructure() As String

    nCTQryLegsGlobal = nCTQryLegsGlobal + 1
            
    
On Error GoTo err_Generic
        
            
    

    '    EURO calendar used for holiday adjustments.

    Dim MyEuroCal As String
    MyEuroCal = _
        CALEUROPart()


    

    '    UK date calendar used within the UK stock exchange.

    Dim MyCALUKExchange As String
    MyCALUKExchange = _
        CALUKExchangePart()


    

    '    Creates a centralized valuation date object.

    Dim MyValuationDate As String
    MyValuationDate = _
        ValueDateObjPart()


    

    '    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 a SABR curve to model the dynamics of the volatility 
    '    curve (smile).
    Dim MySABRVolCurve As String
    MySABRVolCurve = _
        SABRVolCurvePart( _
        MyValuationDate, _
        MyDepoTPL, _
        MySwapTPL)


    

    '    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 MyMiniYC As String
    MyMiniYC = _
        MKTYC_D__3Part( _
        MyValuationDate, _
        MyDepoTPL, _
        MySwapTPL)


    

    '    Creates a new Index code.
    Dim MyNewIndex2 As String
    MyNewIndex2 = _
        CreateIndex__2Part( _
        MyCALUKExchange, _
        MyEuroCal, _
        MyMiniYC)


    

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


    

    '    Creates a floating rate leg.
    Dim MyCreateFloatLeg3 As String
    MyCreateFloatLeg3 = _
        CreateFloatLeg__3Part( _
        MySchedule, _
        MyNewIndex2, _
        MyMarket4)


    

    '    Creates an amortised floating rate leg.
    Dim MyCreateAmortFloatLeg2 As String
    MyCreateAmortFloatLeg2 = _
        CreateAmortFloatLeg__2Part( _
        MyCreateAmortObj, _
        MyNewIndex2, _
        MyMarket4)


    

    '    Creates a Fixed rate leg.
    Dim MyCreateFixedRateLeg3 As String
    MyCreateFixedRateLeg3 = _
        CreateFixedRateLeg__3Part( _
        MySchedule, _
        MyMarket4)


    

    '    This floating leg (or FRN) only provide one payoff.
    Dim MyCreateZCFloatLeg2 As String
    MyCreateZCFloatLeg2 = _
        CreateZCFloatLeg__2Part( _
        MySchedule, _
        MyNewIndex2, _
        MyMarket4)


    

    '    Creates an amortised fixed rate leg.
    Dim MyCreateAmortFixLeg2 As String
    MyCreateAmortFixLeg2 = _
        CreateAmortFixLeg__2Part( _
        MyCreateAmortObj, _
        MyMarket4)


    

    '    Creates a porfolio of caplet or floorlet options from this floating 
    '    Rate Leg.
    Dim MyCreateCapFLTLeg2 As String
    MyCreateCapFLTLeg2 = _
        CreateCapFLTLeg__2Part( _
        MyCreateFloatLeg3, _
        MySABRVolCurve)


    

    '    Creates a Structure object (which is really a portfolio of leg 
    '    objects).
    Dim MyStructure As String
    MyStructure = _
        CreateStructurePart( _
        MyCreateAmortFloatLeg2, _                
        MyCreateFixedRateLeg3, _                
        MyCreateZCFloatLeg2, _                
        MyCreateAmortFixLeg2, _                
        MyCreateCapFLTLeg2)

    ' This is the result we are looking for.
    VB_EX_CreateStructure = MyStructure

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


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

Private Function CreateStructurePart( _
    MyCreateAmortFloatLeg2 As String, _                
    MyCreateFixedRateLeg3 As String, _                
    MyCreateZCFloatLeg2 As String, _                
    MyCreateAmortFixLeg2 As String, _                
    MyCreateCapFLTLeg2 As String) As String


    
        '  Create example range for parameter CreateStructure_Legs

        ' Column vector of 5 rows (indexed from 0, highest index of 4)
        Dim CreateStructure_Legs(4, 0) As Variant
                
        CreateStructure_Legs(0, 0) = MyCreateAmortFloatLeg2
        CreateStructure_Legs(1, 0) = MyCreateFixedRateLeg3
        CreateStructure_Legs(2, 0) = MyCreateZCFloatLeg2
        CreateStructure_Legs(3, 0) = MyCreateAmortFixLeg2
        CreateStructure_Legs(4, 0) = MyCreateCapFLTLeg2
        
            



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


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

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

    '    Creates a Structure object (which is really a portfolio of leg 
    '    objects).
        Dim rCreateStructure As String 
        
        ' We call the CreateCTQryLegs() function via the CTQL module exposed from the CTQL_VBA_API.xla addin.
        Dim oCTQryLegs As CTQryLegs
        Set oCTQryLegs = CTQL.CreateCTQryLegs()
    
        rCreateStructure = oCTQryLegs.CreateStructure( _
                MyStructure, _
                Reload, _
                CreateStructure_Legs)


    CreateStructurePart = rCreateStructure
    
End Function                        








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