IRProcessViewer Example VBA




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

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





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

    nCTIRProcessSimFGlobal = nCTIRProcessSimFGlobal + 1
            
    
On Error GoTo err_Generic
        
            
    

    '    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()


    

    '    EURO calendar used for holiday adjustments.

    Dim MyEuroCal As String
    MyEuroCal = _
        CALEUROPart()


    

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


    

    '    Creates a new Index code.
    Dim MyNewIndex As String
    MyNewIndex = _
        CreateIndexPart( _
        MyCALUKExchange, _
        MyEuroCal, _
        MyYCInterpOnDCF)


    

    '    Creates a Single-factor Hull-White (extended Vasicek) Forward 
    '    ShortRate Model process object.
    Dim MyHullWhite1FProcess As String
    MyHullWhite1FProcess = _
        HullWhite1FProcessPart( _
        MyNewIndex, _
        MyYCInterpOnDCF)


    

    '    Creates an interest rate process viewer object.
    Dim MyIRProcessViewer As String
    MyIRProcessViewer = _
        IRProcessViewerPart( _
        MyHullWhite1FProcess, _
        MyValuationDate)

    ' This is the result we are looking for.
    VB_EX_IRProcessViewer = MyIRProcessViewer

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


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

Private Function IRProcessViewerPart( _
    MyHullWhite1FProcess As String, _                
    MyValuationDate As String) As String


    
        '  Create example range for parameter IRProcessViewer_MandatoryDates

        ' Column vector of 12 rows (indexed from 0, highest index of 11)
        Dim IRProcessViewer_MandatoryDates(11, 0) As Variant
                
        IRProcessViewer_MandatoryDates(0, 0) = DateValue("19/Jul/2005")
        IRProcessViewer_MandatoryDates(1, 0) = DateValue("19/Jan/2006")
        IRProcessViewer_MandatoryDates(2, 0) = DateValue("19/Jul/2006")
        IRProcessViewer_MandatoryDates(3, 0) = DateValue("19/Jan/2007")
        IRProcessViewer_MandatoryDates(4, 0) = DateValue("19/Jul/2007")
        IRProcessViewer_MandatoryDates(5, 0) = DateValue("19/Jan/2008")
        IRProcessViewer_MandatoryDates(6, 0) = DateValue("19/Jul/2008")
        IRProcessViewer_MandatoryDates(7, 0) = DateValue("19/Jan/2009")
        IRProcessViewer_MandatoryDates(8, 0) = DateValue("19/Jul/2009")
        IRProcessViewer_MandatoryDates(9, 0) = DateValue("19/Jan/2010")
        IRProcessViewer_MandatoryDates(10, 0) = DateValue("19/Jul/2010")
        IRProcessViewer_MandatoryDates(11, 0) = DateValue("19/Jan/2011")
        
            



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


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


    '    Used to calculate time in years.
        Dim dayCounter As String
        dayCounter = "30360"


    '    The number of simulations.
        Dim NoOfSims As Long
        NoOfSims = 10


    '    The random generator type to use.
        Dim MCMethod As String
        MCMethod = "Pseudo"


    '    Seed value.
        Dim Seed As Long
        Seed = 0

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

    '    Creates an interest rate process viewer object.
        Dim rIRProcessViewer As String 
        
        ' We call the CreateCTIRProcessSimF() function via the CTQL module exposed from the CTQL_VBA_API.xla addin.
        Dim oCTIRProcessSimF As CTIRProcessSimF
        Set oCTIRProcessSimF = CTQL.CreateCTIRProcessSimF()
    
        rIRProcessViewer = oCTIRProcessSimF.IRProcessViewer( _
                MyIRProcessViewer, _
                Reload, _
                MyHullWhite1FProcess, _
                MyValuationDate, _
                dayCounter, _
                IRProcessViewer_MandatoryDates, _
                NoOfSims, _
                MCMethod, _
                Seed)


    IRProcessViewerPart = rIRProcessViewer
    
End Function                        







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