CallableBondDirtyPrice




http://www.QuantTools.com
CapeTools IREngineOptions function list

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

Key TAGs | Excel Index | API Index


Prices the Dirty price of a Callable Bond Option object.

You can indicate whether you wish to have the price of the option added to the underlying Bond's Dirty price.

This function requires the input of an option pricing object key, which must have been produced via a call to the CallableBondOption() function.

This function would have returned a string 'KEY' which is to be passed to the 'Key' parameter of this function.



Note: Within Excel, the function is named - CT.OPT.CallableBondDirtyPrice


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



Parameter Description


  1. Key parameter

    Option object Key to an already created CallableBondOption object.
  2. IncOption parameter

    Do you wish to add the price of the option to the bond's dirty price?


Extended information

Function Syntax

VB Syntax 


Double CTIREngineOptions.CallableBondDirtyPrice( _
String Key, _
Boolean IncOption)


Excel Spreadsheet Syntax 


=CT.OPT.CallableBondDirtyPrice(
Excel String Cell Key,
Excel Boolean Value Cell IncOption)


C++ Syntax 


static double CallableBondDirtyPrice(
std::string Key,
bool IncOption);


DotNET Syntax 


System.Double CTIREngineOptionsSA.CallableBondDirtyPrice(
System.String Key,
System.Boolean IncOption);

Parameter data types

ArgNameArgTypeIsKey
KeyStringTRUE
IncOptionBooleanFALSE

Example Inputs

The first column represents the name of the parameters. The second column specifies whether the parameters are optional or not. Finally the last column provides some sample input data.
Function call input string-keys are always in the format : "NAME.EXTTAG.TICKER" The "EXTTAG.TICKER" part is determined from the output of other, capetools, object creation functions.


ArgNameIsOptional (Excel only)Example
KeyFALSEKeyNAME.EXTTAG.TICKER (from a function call)
IncOptionFALSEtrue


Example function usage


The C# example below contains all the sub-function calls leading up to this function call. As a result, the example can contain a lot of code.

The VB.NET, J#, C++.NET, Java, Excel VBA, Visual Basic 6 (via COM) and C++ examples below contain function code stubs for the calls leading up to this function call. However, the function call for this function is displayed.
You can easily reproduce the stub functions code from the C# example.


If you are accessing this functrion via the MiniXL libraries, this function is present within the CT.QL.EnginePricing20 MiniXL Excel Addin.

Within our Excel Example Addin Generator, we have used the following QuantTools sub-functions in order to prepare the arguments needed to call the CallableBondDirtyPrice() function. If you are executing this function via the MiniXL libraries, the module addin name, (in brackets, to the right of the sub-functions listed below), indicates the MiniXL library in which the sub-function is held. You will need to load this library into your Excel session (along with any other libraries that the sub-function call within the addin requires (ie - CT.QT.Utils20 addin in almost all cases) in order for the example to compute successfully.

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





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




The following four examples demostrate calling this function within a Microsoft .NET environment

The following four examples demostrate calling this function within a non .NET environment

The following is a sample output from executing the CallableBondDirtyPrice() function call


105.774194816384

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