SaveVCRiskReport




http://www.QuantTools.com
CapeTools IR Risk function list

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

Key TAGs | Excel Index | API Index


Saves a generated VolCurve risk report to file.

The report must have been generated via a call to one of the following functions : ReadVCRiskReport(), CreateSABRReport(), CreateVegaReport() or CreateVolgaReport().



Note: Within Excel, the function is named - CT.RSK.SaveVCRiskReport


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



Parameter Description


  1. Key parameter

    Key to an already created volatility type risk report object (ReadVCRiskReport(), CreateSABRReport(), CreateVegaReport() or CreateVolgaReport()).
  2. FileName parameter

    Name of the file to write to (can include path). Must end with a '.rep' extension. If none is provided, the extension will be added.
  3. Path parameter

    Optional directory path. Will be pre-pended to the FileName parameter.


Extended information

Function Syntax

VB Syntax 


String CTIRRisk.SaveVCRiskReport( _
String Key, _
String FileName, _
String Path)


Excel Spreadsheet Syntax 


=CT.RSK.SaveVCRiskReport(
Excel String Cell Key,
Excel String Cell FileName,
Excel String Cell Path)


C++ Syntax 


static std::string SaveVCRiskReport(
std::string Key,
std::string FileName,
std::string Path);


DotNET Syntax 


System.String CTIRRiskSA.SaveVCRiskReport(
System.String Key,
System.String FileName,
System.String Path);

Parameter data types

ArgNameArgTypeIsKey
KeyStringTRUE
FileNameStringFALSE
PathStringFALSE

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)
FileNameFALSEVega.rep
PathTRUEC:


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.IRRisk20 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 SaveVCRiskReport() 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 SaveVCRiskReport() function call


OK

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