QueryRangeDB





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

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

Key TAGs | Excel Index | API Index



Given ANY 'KEY' string value generated by a CapeTool function, you can query for the value of ANY range object parameter.

You simply provide the 'KEY' string and the name of the parameter used within the function that created the 'KEY'. Thus if you used the FloatingRateBond() function and later on wanted to know the value entered for the 'spreads' range object parameter, simply enter the key value returned from the FloatingRateBond() function here, along with the string 'spreads' (without the single quotes) for the ParamName parameter and the value entered during the construction of the FloatingRateBond() function will be returned.



Note: Within Excel, the function is named - CT.DB.QueryRangeDB




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



Parameter Description


  1. Key parameter

    The KEY generated by a CapeTools function.
  2. ParamName parameter

    The name of the RANGE valued parameter that you wish to query for.


Extended information

Function Syntax

VB Syntax


Variant CTQueryDB.QueryRangeDB( _
String Key, _
String ParamName)


Excel Spreadsheet Syntax


=CT.DB.QueryRangeDB(
Excel String Cell Key,
Excel String Cell ParamName)


C++ Syntax


static CTRangeDataCPP QueryRangeDB(
std::string Key,
std::string ParamName);


DotNET Syntax


CTRangeData CTQueryDBSA.QueryRangeDB(
System.String Key,
System.String ParamName);

Parameter data types

ArgNameArgTypeIsKey
KeyStringTRUE
ParamNameStringFALSE


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)
ParamNameFALSEoTenorsVals


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.Utils20 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 QueryRangeDB() 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 QueryRangeDB() function call


Example
385523.5true
2M3.51true
3M3.52true
4M3.54true
5M3.56true
6M3.59true
7M3.61true
8M3.63true
9M3.65true
10M3.68true
11M3.71true
12M3.73true
3Y3.76true
4Y3.79true
5Y3.81true
6Y3.84true
7Y3.87true
8Y3.91true
9Y3.95true
10Y3.99true
11Y4.02true
12Y4.04true
13Y4.09true
14Y4.11true
15Y4.15true
16Y4.18true
17Y4.22true
18Y4.25true
19Y4.27true
20Y4.3true
21Y4.35true
22Y4.38true



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