Instrument Class Reference

Abstract instrument class. More...

#include <ql/instrument.hpp>

Inheritance diagram for Instrument:

Public Member Functions
Inspectors
Real	NPV () const
	returns the net present value of the instrument.
Real	errorEstimate () const
	returns the error estimate on the NPV when available.
const Date &	valuationDate () const
	returns the date the net present value refers to.
template<typename T>
T	result (const std::string &tag) const
	returns any additional result returned by the pricing engine.
const std::map< std::string, ext::any > &	additionalResults () const
	returns all additional result returned by the pricing engine.
virtual bool	isExpired () const =0
	returns whether the instrument might have value greater than zero.
Modifiers
void	setPricingEngine (const ext::shared_ptr< PricingEngine > &)
	set the pricing engine to be used.
virtual void	setupArguments (PricingEngine::arguments *) const
virtual void	fetchResults (const PricingEngine::results *) const
Public Member Functions inherited from LazyObject
void	update () override
bool	isCalculated () const
void	forwardFirstNotificationOnly ()
void	alwaysForwardNotifications ()
void	recalculate ()
void	freeze ()
void	unfreeze ()
Public Member Functions inherited from Observable
	Observable (const Observable &)
Observable &	operator= (const Observable &)
	Observable (Observable &&)=delete
Observable &	operator= (Observable &&)=delete
void	notifyObservers ()
Public Member Functions inherited from Observer
	Observer (const Observer &)
Observer &	operator= (const Observer &)
std::pair< iterator, bool >	registerWith (const ext::shared_ptr< Observable > &)
void	registerWithObservables (const ext::shared_ptr< Observer > &)
Size	unregisterWith (const ext::shared_ptr< Observable > &)
void	unregisterWithAll ()
virtual void	deepUpdate ()

Protected Member Functions
Calculations
void	calculate () const override
virtual void	setupExpired () const
void	performCalculations () const override

Protected Attributes
Results
The value of this attribute and any other that derived classes might declare must be set during calculation.
Real	NPV_
Real	errorEstimate_
Date	valuationDate_
std::map< std::string, ext::any >	additionalResults_
ext::shared_ptr< PricingEngine >	engine_
bool	calculated_ = false
bool	frozen_ = false
bool	alwaysForward_

Additional Inherited Members
Public Types inherited from Observer
typedef set_type::iterator	iterator

Detailed Description

Abstract instrument class.

This class is purely abstract and defines the interface of concrete instruments which will be derived from this one.

Tests

observability of class instances is checked.

Member Function Documentation

isExpired()

virtual bool isExpired ( ) const

pure virtual

returns whether the instrument might have value greater than zero.

Implemented in Bond, CapFloor, CDO, CdsOption, CompositeInstrument, CPICapFloor, CreditDefaultSwap, EnergyFuture, EnergyVanillaSwap, FloatFloatSwaption, Forward, ForwardRateAgreement, IrregularSwaption, MultiAssetOption, NonstandardSwaption, NthToDefault, OneAssetOption, OvernightIndexFuture, PathMultiAssetOption, PerpetualFutures, Stock, Swap, Swaption, SyntheticCDO, TwoAssetBarrierOption, VanillaStorageOption, VanillaSwingOption, VarianceOption, VarianceSwap, WriterExtensibleOption, and YoYInflationCapFloor.

setPricingEngine()

void setPricingEngine

(

const ext::shared_ptr< PricingEngine > &

)

set the pricing engine to be used.

Warning

calling this method will have no effects in case the performCalculation method was overridden in a derived class.

Examples

Bonds.cpp, CDS.cpp, ConvertibleBonds.cpp, EquityOption.cpp, MulticurveBootstrapping.cpp, and Replication.cpp.

setupArguments()

virtual void setupArguments ( PricingEngine::arguments * ) const

virtual

When a derived argument structure is defined for an instrument, this method should be overridden to fill it. This is mandatory in case a pricing engine is used.

Reimplemented in AssetSwap, BarrierOption, Bond, CallableBond, CapFloor, CdsOption, CliquetOption, ComplexChooserOption, CompoundOption, ContinuousAveragingAsianOption, ContinuousFixedLookbackOption, ContinuousFloatingLookbackOption, ContinuousPartialFixedLookbackOption, ContinuousPartialFloatingLookbackOption, ConvertibleBond, CPICapFloor, CPISwap, CreditDefaultSwap, DiscreteAveragingAsianOption, DoubleBarrierOption, EnergyCommodity, FixedVsFloatingSwap, FloatFloatSwap, FloatFloatSwaption, ForwardVanillaOption, HimalayaOption, HolderExtensibleOption, IrregularSwap, IrregularSwaption, MargrabeOption, MultiAssetOption, NonstandardSwap, NonstandardSwaption, NthToDefault, Option, PagodaOption, PartialTimeBarrierOption, PathMultiAssetOption, PerpetualFutures, SimpleChooserOption, SoftBarrierOption, Swap, Swaption, SyntheticCDO, TwoAssetBarrierOption, TwoAssetCorrelationOption, VanillaStorageOption, VanillaSwingOption, VarianceOption, VarianceSwap, WriterExtensibleOption, YearOnYearInflationSwap, and YoYInflationCapFloor.

fetchResults()

void fetchResults ( const PricingEngine::results * r ) const

virtual

When a derived result structure is defined for an instrument, this method should be overridden to read from it. This is mandatory in case a pricing engine is used.

Reimplemented in AssetSwap, Bond, CPISwap, CreditDefaultSwap, EnergyCommodity, FixedVsFloatingSwap, FloatFloatSwap, ForwardVanillaOption, IrregularSwap, MargrabeOption, MultiAssetOption, NonstandardSwap, NthToDefault, OneAssetOption, QuantoBarrierOption, QuantoDoubleBarrierOption, QuantoForwardVanillaOption, QuantoVanillaOption, Swap, SyntheticCDO, VarianceSwap, and YearOnYearInflationSwap.

calculate()

void calculate ( ) const

overrideprotectedvirtual

This method performs all needed calculations by calling the performCalculations method.

Warning

Objects cache the results of the previous calculation. Such results will be returned upon later invocations of calculate. When the results depend on arguments which could change between invocations, the lazy object must register itself as observer of such objects for the calculations to be performed again when they change.

Warning

Should this method be redefined in derived classes, LazyObject::calculate() should be called in the overriding method.

Reimplemented from LazyObject.

setupExpired()

void setupExpired ( ) const

protectedvirtual

This method must leave the instrument in a consistent state when the expiration condition is met.

Reimplemented in Bond, CreditDefaultSwap, ForwardRateAgreement, MultiAssetOption, OneAssetOption, PathMultiAssetOption, Swap, and VarianceSwap.

performCalculations()

void performCalculations ( ) const

overrideprotectedvirtual

In case a pricing engine is not used, this method must be overridden to perform the actual calculations and set any needed results. In case a pricing engine is used, the default implementation can be used.

Implements LazyObject.

Reimplemented in Stock.