IsCashSettled




http://www.QuantTools.com
CapeTools FpML Swaption function list

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

Key TAGs | Excel Index | API Index


Is the Swaption Cash Settled? The XPath query which can also be passed to the FpMLGenericQuery() function to generate the same result is : count(//descendant::Swaption/cashSettlement) > 0. This function requires the input of a FpMLDoc object key, which must have been produced via a call to the ReadFpML() function.

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

If you were looking at the FpML document, a typical example of walking to this(these) node(s) would be...

  // FpML Document -> IsOrAreNodesPresent(

    -> Swaption

      -> cashSettlement)

Or if using the FpMLGenericQuery() function...

count(//descendant::Swaption/cashSettlement) > 0




Note: Within Excel, the function is named - CT.FpML.OS.IsCashSettled


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



Parameter Description


  1. FpMLDocKey parameter

    Key to an already loaded FpML Key Object


Extended information

Function Syntax

VB Syntax 


Boolean CTFpMLOS.IsCashSettled( _
String FpMLDocKey)


Excel Spreadsheet Syntax 


=CT.FpML.OS.IsCashSettled(
Excel String Cell FpMLDocKey)


C++ Syntax 


static bool IsCashSettled(
std::string FpMLDocKey);


DotNET Syntax 


System.Boolean CTFpMLOSSA.IsCashSettled(
System.String FpMLDocKey);

Parameter data types

ArgNameArgTypeIsKey
FpMLDocKeyStringTRUE

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

Example function usage


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





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




You can refer to the examples within the CapeTools FpML category of functions for examples of how to execute this function.
Simply read in your FpML file and use the CTFpMLOS class from the COM (ActiveX Dll), CTFpMLOSSA class from .NET, C++ or Java or the CreateCTFpMLOS() method from Excel VBA to obtain a handle to the object needed to execute the IsCashSettled() function.

Note : These examples, as well as the Excel example require a correct path to an FpML file.


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