Quotes

Overview

quotes objects.

Function List

qlBucketAnalysis ()
qlBucketAnalysisDelta ()
qlBucketAnalysisDelta2 ()
qlCompositeQuote ()
qlEurodollarFuturesImpliedStdDevQuote ()
qlForwardSwapQuote ()
qlForwardValueQuote ()
qlFuturesConvAdjustmentQuote ()
qlFuturesConvAdjustmentQuoteFuturesValue ()
qlFuturesConvAdjustmentQuoteImmDate ()
qlFuturesConvAdjustmentQuoteMeanReversion ()
qlFuturesConvAdjustmentQuoteVolatility ()
qlImpliedStdDevQuote ()
qlLastFixingQuote ()
qlLastFixingQuoteReferenceDate ()
qlQuoteIsValid ()
qlQuoteValue ()
qlRelinkableHandleQuote ()
qlSimpleQuote ()
qlSimpleQuoteReset ()
qlSimpleQuoteSetTickValue ()
qlSimpleQuoteSetValue ()
qlSimpleQuoteTickValue ()

Function Documentation

qlBucketAnalysis

vector<vector<double> > returnValue
qlBucketAnalysis(
vector<vector<string> > SimpleQuote
vector<string> Instruments
vector<double> Quantities
double Shift
string SensitivityAnalysis
any Trigger)
Description:

delta NPV bucket sensitivity analysis for a (single/vector/matrix) SimpleQuote.

Supported Platforms:

Excel

Parameters
SimpleQuotesimple quotes.
Instrumentsinstruments.
Quantitiesquantities.
Shiftshift. Default value = 0.0001.
SensitivityAnalysisSensitivityAnalysis type. Default value = Centered.
Triggerdependency tracking trigger

qlBucketAnalysisDelta

vector<double> returnValue
qlBucketAnalysisDelta(
string SimpleQuote
vector<string> Parameters
double Shift
string SensitivityAnalysis
any Trigger)
Description:

Parameters' bucket analysis delta for a single SimpleQuote.

Supported Platforms:

Excel

Parameters
SimpleQuotesimple quote.
Parametersparameters vector.
Shiftshift. Default value = 0.0001.
SensitivityAnalysisSensitivityAnalysis type. Default value = Centered.
Triggerdependency tracking trigger

qlBucketAnalysisDelta2

vector<vector<double> > returnValue
qlBucketAnalysisDelta2(
vector<string> SimpleQuote
vector<string> Parameters
double Shift
string SensitivityAnalysis
any Trigger)
Description:

Parameters' bucket analysis delta for a SimpleQuote vector.

Supported Platforms:

Excel

Parameters
SimpleQuotesimple quote.
Parametersparameters vector.
Shiftshift. Default value = 0.0001.
SensitivityAnalysisSensitivityAnalysis type. Default value = Centered.
Triggerdependency tracking trigger

qlCompositeQuote

string returnValue
qlCompositeQuote(
string ObjectId
string Element1
string Element2
string Operator
bool Permanent
any Trigger
bool Overwrite)
Description:

Construct an object of class CompositeQuote and return its id

Supported Platforms:

Excel, C++

Parameters
ObjectIdid of object to be created
Element1the first, i.e. x, value in the f(x,y) expression.
Element2the second, i.e. y, value in the f(x,y) expression.
Operatorthe operator to be applied, e.g. ""+"" or ""-"".
Permanentobject permanent/nonpermanent
Triggerdependency tracking trigger
Overwriteoverwrite flag

qlEurodollarFuturesImpliedStdDevQuote

string returnValue
qlEurodollarFuturesImpliedStdDevQuote(
string ObjectId
string AtmForwardValue
string CallPrice
string PutPrice
double Strike
double Guess
double Accuracy
bool Permanent
any Trigger
bool Overwrite)
Description:

Construct an object of class EurodollarFuturesImpliedStdDevQuote and return its id

Supported Platforms:

Excel, C++

Parameters
ObjectIdid of object to be created
AtmForwardValueunderlying asset at-the-money forward value.
CallPricecall option price.
PutPriceput option price.
Strikeoption strike.
Guessimplied volatility guess. Default value = QuantLib::Null<QuantLib::Real>().
Accuracystandard deviation accuracy. Default value = 1e-6.
Permanentobject permanent/nonpermanent
Triggerdependency tracking trigger
Overwriteoverwrite flag

qlForwardSwapQuote

string returnValue
qlForwardSwapQuote(
string ObjectId
string SwapIndex
string Spread
string ForwardStart
bool Permanent
any Trigger
bool Overwrite)
Description:

Construct an object of class ForwardSwapQuote and return its id

Supported Platforms:

Excel, C++

Parameters
ObjectIdid of object to be created
SwapIndexfloating SwapIndex object ID.
Spreadfloating leg spread.
ForwardStartforward start period.
Permanentobject permanent/nonpermanent
Triggerdependency tracking trigger
Overwriteoverwrite flag

qlForwardValueQuote

string returnValue
qlForwardValueQuote(
string ObjectId
string IborIndex
long FixingDate
bool Permanent
any Trigger
bool Overwrite)
Description:

Construct an object of class ForwardValueQuote and return its id

Supported Platforms:

Excel, C++

Parameters
ObjectIdid of object to be created
IborIndexfloating IborIndex object ID.
FixingDateFixing Date.
Permanentobject permanent/nonpermanent
Triggerdependency tracking trigger
Overwriteoverwrite flag

qlFuturesConvAdjustmentQuote

string returnValue
qlFuturesConvAdjustmentQuote(
string ObjectId
string IborIndex
string ImmCode
string FuturesQuote
string Volatility
string MeanReversion
bool Permanent
any Trigger
bool Overwrite)
Description:

Construct an object of class FuturesConvAdjustmentQuote and return its id

Supported Platforms:

Excel, C++

Parameters
ObjectIdid of object to be created
IborIndexfloating IborIndex object ID.
ImmCodefutures IMM code (e.g. H9).
FuturesQuotefutures quote.
VolatilityHullWhite volatility.
MeanReversionHullWhite mean reversion.
Permanentobject permanent/nonpermanent
Triggerdependency tracking trigger
Overwriteoverwrite flag

qlFuturesConvAdjustmentQuoteFuturesValue

double returnValue
qlFuturesConvAdjustmentQuoteFuturesValue(
string ObjectId
any Trigger)
Description:

Return the value of futures underlying.

Supported Platforms:

Excel

Parameters
ObjectIdid of existing QuantLib::FuturesConvAdjustmentQuote object
Triggerdependency tracking trigger

qlFuturesConvAdjustmentQuoteImmDate

long returnValue
qlFuturesConvAdjustmentQuoteImmDate(
string ObjectId
any Trigger)
Description:

Return the IMM date of futures.

Supported Platforms:

Excel

Parameters
ObjectIdid of existing QuantLib::FuturesConvAdjustmentQuote object
Triggerdependency tracking trigger

qlFuturesConvAdjustmentQuoteMeanReversion

double returnValue
qlFuturesConvAdjustmentQuoteMeanReversion(
string ObjectId
any Trigger)
Description:

Return the value of HW mean reversion.

Supported Platforms:

Excel

Parameters
ObjectIdid of existing QuantLib::FuturesConvAdjustmentQuote object
Triggerdependency tracking trigger

qlFuturesConvAdjustmentQuoteVolatility

double returnValue
qlFuturesConvAdjustmentQuoteVolatility(
string ObjectId
any Trigger)
Description:

Return the value of HW volatility.

Supported Platforms:

Excel

Parameters
ObjectIdid of existing QuantLib::FuturesConvAdjustmentQuote object
Triggerdependency tracking trigger

qlImpliedStdDevQuote

string returnValue
qlImpliedStdDevQuote(
string ObjectId
string OptionType
string AtmForwardValue
string OptionPrice
double Strike
double Guess
double Accuracy
bool Permanent
any Trigger
bool Overwrite)
Description:

Construct an object of class ImpliedStdDevQuote and return its id

Supported Platforms:

Excel, C++

Parameters
ObjectIdid of object to be created
OptionTypeoption type (i.e. Call or Put).
AtmForwardValueunderlying asset at-the-money forward value.
OptionPriceoption price.
Strikeoption strike.
Guessimplied volatility guess. Default value = QuantLib::Null<QuantLib::Real>().
Accuracyiv accuracy. Default value = 1e-6.
Permanentobject permanent/nonpermanent
Triggerdependency tracking trigger
Overwriteoverwrite flag

qlLastFixingQuote

string returnValue
qlLastFixingQuote(
string ObjectId
string Index
bool Permanent
any Trigger
bool Overwrite)
Description:

Construct an object of class LastFixingQuote and return its id

Supported Platforms:

Excel, C++

Parameters
ObjectIdid of object to be created
IndexIndex object ID.
Permanentobject permanent/nonpermanent
Triggerdependency tracking trigger
Overwriteoverwrite flag

qlLastFixingQuoteReferenceDate

long returnValue
qlLastFixingQuoteReferenceDate(
string ObjectId
any Trigger)
Description:

Return the date of the last fixing

Supported Platforms:

Excel

Parameters
ObjectIdid of existing QuantLib::LastFixingQuote object
Triggerdependency tracking trigger

qlQuoteIsValid

bool returnValue
qlQuoteIsValid(
string ObjectId
any Trigger)
Description:

Returns TRUE if the given Quote object has a valid value.

Supported Platforms:

Excel, Calc

Parameters
ObjectIdid of existing QuantLib::Quote object
Triggerdependency tracking trigger

qlQuoteValue

double returnValue
qlQuoteValue(
string ObjectId
any Trigger)
Description:

Returns the current value of the given Quote object.

Supported Platforms:

Excel, Calc

Parameters
ObjectIdid of existing QuantLib::Quote object
Triggerdependency tracking trigger

qlRelinkableHandleQuote

string returnValue
qlRelinkableHandleQuote(
string ObjectId
string CurrentLink
bool Permanent
any Trigger
bool Overwrite)
Description:

Construct an object of class RelinkableHandleImpl<QuantLibAddin::Quote, QuantLib::Quote> and return its id

Supported Platforms:

Excel, Calc, C++

Parameters
ObjectIdid of object to be created
CurrentLinkQuote object ID. If omitted, nothing is linked by the RelinkableHandle. Default value = .
Permanentobject permanent/nonpermanent
Triggerdependency tracking trigger
Overwriteoverwrite flag

qlSimpleQuote

string returnValue
qlSimpleQuote(
string ObjectId
double Value
double TickValue
bool Permanent
any Trigger
bool Overwrite)
Description:

Construct an object of class SimpleQuote and return its id

Supported Platforms:

Excel, Calc, C++

Parameters
ObjectIdid of object to be created
Valuequote. Default value = QuantLib::Null<QuantLib::Real>().
TickValuetick value used for sensitivity analysis.
Permanentobject permanent/nonpermanent
Triggerdependency tracking trigger
Overwriteoverwrite flag

qlSimpleQuoteReset

void returnValue
qlSimpleQuoteReset(
string ObjectId
any Trigger)
Description:

resets the given SimpleQuote object to the uninitialized state.

Supported Platforms:

Excel, Calc

Parameters
ObjectIdid of existing QuantLib::SimpleQuote object
Triggerdependency tracking trigger

qlSimpleQuoteSetTickValue

void returnValue
qlSimpleQuoteSetTickValue(
string ObjectId
double Value
any Trigger)
Description:

sets the tick value of the given SimpleQuote object.

Supported Platforms:

Excel

Parameters
ObjectIdid of existing QuantLibAddin::SimpleQuote object
Valuethe new tick value.
Triggerdependency tracking trigger

qlSimpleQuoteSetValue

double returnValue
qlSimpleQuoteSetValue(
string ObjectId
double Value
any Trigger)
Description:

sets a new value to the given SimpleQuote object and returns the difference with the previous value.

Supported Platforms:

Excel, Calc, C++

Parameters
ObjectIdid of existing QuantLibAddin::SimpleQuote object
Valuethe new value. Default value = QuantLib::Null<QuantLib::Real>().
Triggerdependency tracking trigger

qlSimpleQuoteTickValue

double returnValue
qlSimpleQuoteTickValue(
string ObjectId
any Trigger)
Description:

returns the tick value of the given SimpleQuote object.

Supported Platforms:

Excel

Parameters
ObjectIdid of existing QuantLibAddin::SimpleQuote object
Triggerdependency tracking trigger