Instruments

Overview

functions to construct and use Instrument objects.

Function List

qlInstrumentErrorEstimate ()
qlInstrumentIsExpired ()
qlInstrumentNPV ()
qlInstrumentResults ()
qlInstrumentSetPricingEngine ()
qlInstrumentValuationDate ()

Function Documentation

qlInstrumentErrorEstimate

double returnValue
qlInstrumentErrorEstimate(
string ObjectId
any Trigger)
Description:

Returns the NPV error estimation (for e.g. Monte Carlo simulation) for the given Instrument object.

Supported Platforms:

Excel

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

qlInstrumentIsExpired

bool returnValue
qlInstrumentIsExpired(
string ObjectId
any Trigger)
Description:

Returns TRUE if the given Instrument object is expired.

Supported Platforms:

Excel

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

qlInstrumentNPV

double returnValue
qlInstrumentNPV(
string ObjectId
any Trigger)
Description:

Returns the NPV for the given Instrument object.

Supported Platforms:

Excel, Calc, Guile, C, C++

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

qlInstrumentResults

double returnValue
qlInstrumentResults(
string ObjectId
string ResultType
any Trigger)
Description:

Returns the required result (if available) for the given Instrument object.

Supported Platforms:

Excel

Parameters
ObjectIdid of existing QuantLib::Instrument object
ResultTyperesult type (e.g. 'vega').
Triggerdependency tracking trigger

qlInstrumentSetPricingEngine

void returnValue
qlInstrumentSetPricingEngine(
string ObjectId
string PricingEngine
any Trigger)
Description:

Sets a new pricing engine to the given Instrument object.

Supported Platforms:

Excel, C++, Calc

Parameters
ObjectIdid of existing QuantLibAddin::Instrument object
PricingEnginePricingEngine object ID.
Triggerdependency tracking trigger

qlInstrumentValuationDate

long returnValue
qlInstrumentValuationDate(
string ObjectId
any Trigger)
Description:

Returns the date to which the net present value refers.

Supported Platforms:

Excel, Calc, Guile, C, C++

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