LMMDisplayStep Example VBA




http://www.QuantTools.com
CapeTools LMM Process Simulation function list
LMMDisplayStep 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 LMMDisplayStep() )

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





    '     ##################################################################################
    '     The first function here LMMDisplayStep(), contains a series of
    '     function calls leading upto the main function call, the second function
    '     within this file ( LMMDisplayStepPart() ).
    '     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 nCTLMMProcessSimGlobal As Long
    
    
Public Function VB_EX_LMMDisplayStep() As Variant

    nCTLMMProcessSimGlobal = nCTLMMProcessSimGlobal + 1
            
    
On Error GoTo err_Generic
        
            
    

    '    UK date calendar used within the UK stock exchange.

    Dim MyCALUKExchange As String
    MyCALUKExchange = _
        CALUKExchangePart()


    

    '    EURO calendar used for holiday adjustments.

    Dim MyEuroCal As String
    MyEuroCal = _
        CALEUROPart()


    

    '    Creates a centralized valuation date object.

    Dim MyValuationDate As String
    MyValuationDate = _
        ValueDateObjPart()


    

    '    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 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 Libor Forward Model Process container object.
    Dim MyLMMProcess2 As String
    MyLMMProcess2 = _
        LMMProcess2Part( _
        MyNewIndex2)


    

    '    Creates a an extended linear-exponential volatility model for 
    '    the libor market model.
    Dim My3rdLMMLinearExpVolModel2 As String
    My3rdLMMLinearExpVolModel2 = _
        LMMLinearExpVolModel2__3Part( _
        MyLMMProcess2)


    

    '    Creates an extended exponential correlation model for the libor 
    '    market model.
    Dim My2ndLMMLinearExpCorrModel2 As String
    My2ndLMMLinearExpCorrModel2 = _
        LMMLinearExpCorrModel2__2Part( _
        MyLMMProcess2)


    

    '    Given volatility and correlation specification objects, creates 
    '    a Libor Forward Market Simulation Process object to be used 
    '    within the 'CapeTools LMM Process Simulation' or 'CapeTools 
    '    Generic IR LMM MonteCarlo Pricer' category of functions.
    Dim MyLMMSimProcess As String
    MyLMMSimProcess = _
        LMMSimProcessPart( _
        MyLMMProcess2, _
        My3rdLMMLinearExpVolModel2, _
        My2ndLMMLinearExpCorrModel2)


    

    '    Displays the value of the LIBOR rates at a particular time step 
    '    across all simulations.
    Dim resLMMDisplayStep As Variant
    resLMMDisplayStep = _
        LMMDisplayStepPart( _
        MyLMMSimProcess)

    ' This is the result we are looking for.
    VB_EX_LMMDisplayStep = resLMMDisplayStep

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


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

Private Function LMMDisplayStepPart( _
    MyLMMSimProcess As String) As Variant


    



    '    The index within the TimeLine range passed into the LMM Process 
    '    object (1-based).
        Dim TimeStep As Long
        TimeStep = 1

                    
    '  Excel function call is : "CT.PRO.LMMDisplayStep()"

    '    Displays the value of the LIBOR rates at a particular time step 
    '    across all simulations.
        Dim rLMMDisplayStep As Variant 
        
        ' We call the CreateCTLMMProcessSim() function via the CTQL module exposed from the CTQL_VBA_API.xla addin.
        Dim oCTLMMProcessSim As CTLMMProcessSim
        Set oCTLMMProcessSim = CTQL.CreateCTLMMProcessSim()
    
        rLMMDisplayStep = oCTLMMProcessSim.LMMDisplayStep( _
                MyLMMSimProcess, _
                TimeStep)


    LMMDisplayStepPart = rLMMDisplayStep
    
End Function                        







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