Instruments
Overview
functions to construct and use Instrument objects.
Function List
qlInstrumentErrorEstimate ()
qlInstrumentIsExpired ()
qlInstrumentNPV ()
qlInstrumentResults ()
qlInstrumentSetPricingEngine ()
qlInstrumentValuationDate ()
Function Documentation
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
-
ObjectId id of existing QuantLib::Instrument object Trigger dependency tracking trigger
bool returnValue
qlInstrumentIsExpired(
string ObjectId
any Trigger)
- Description:
Returns TRUE if the given Instrument object is expired.
- Supported Platforms:
Excel
- Parameters
-
ObjectId id of existing QuantLib::Instrument object Trigger dependency tracking trigger
double returnValue
qlInstrumentNPV(
string ObjectId
any Trigger)
- Description:
Returns the NPV for the given Instrument object.
- Supported Platforms:
Excel, Calc, Guile, C, C++
- Parameters
-
ObjectId id of existing QuantLib::Instrument object Trigger dependency tracking trigger
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
-
ObjectId id of existing QuantLib::Instrument object ResultType result type (e.g. 'vega'). Trigger dependency tracking trigger
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
-
ObjectId id of existing QuantLibAddin::Instrument object PricingEngine PricingEngine object ID. Trigger dependency tracking trigger
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
-
ObjectId id of existing QuantLib::Instrument object Trigger dependency tracking trigger