BondSummary




http://www.QuantTools.com
CapeTools Query Bonds function list

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

Key TAGs | Excel Index | API Index


Return a range object containing bond summary information.

The Bond object that is to be queried must have been previously created via one of the Bond creation functions.

These Bond functions would have returned a string 'KEY' which is to be passed to the 'BondKey' parameter of this function.



Note: Within Excel, the function is named - CT.BOND.BondSummary


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



Parameter Description


  1. BondKey parameter

    Key Handle to an already constructed BOND object.


Extended information

Function Syntax

VB Syntax 


Variant CTQryBonds.BondSummary( _
String BondKey)


Excel Spreadsheet Syntax 


=CT.BOND.BondSummary(
Excel String Cell BondKey)


C++ Syntax 


static CTRangeDataCPP BondSummary(
std::string BondKey);


DotNET Syntax 


CTRangeData CTQryBondsSA.BondSummary(
System.String BondKey);

Parameter data types

ArgNameArgTypeIsKey
BondKeyStringTRUE

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
BondKeyFALSEBondKeyNAME.EXTTAG.TICKER (from a function call)


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.Bonds20 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 BondSummary() 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 BondSummary() function call


Example
DirtyPrice97.4775
CleanPrice96.2553
MacauleyDuration7.69814
ModifiedDuration7.49211
Convexity68.9698
BPV-0.0730309
YVBP-1.36928e-005
NextCashFlow38646
PrevCashFlow38463
DaysToMaturity3563
YearsToMaturity9.75556
DaysToNextFlow94
DaysAccured89
NumOfCashFlows20



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