FxSwapRateHelper Class Reference

Rate helper for bootstrapping over Fx Swap rates. More...

#include <ql/termstructures/yield/ratehelpers.hpp>

Inheritance diagram for FxSwapRateHelper:

Public Member Functions
	FxSwapRateHelper (const Handle< Quote > &fwdPoint, Handle< Quote > spotFx, const Period &tenor, Natural fixingDays, Calendar calendar, BusinessDayConvention convention, bool endOfMonth, bool isFxBaseCurrencyCollateralCurrency, Handle< YieldTermStructure > collateralCurve, Calendar tradingCalendar=Calendar())
	FxSwapRateHelper (const Handle< Quote > &fwdPoint, Handle< Quote > spotFx, const Date &startDate, const Date &endDate, bool isFxBaseCurrencyCollateralCurrency, Handle< YieldTermStructure > collateralCurve)
RateHelper interface
Real	impliedQuote () const override
void	setTermStructure (YieldTermStructure *) override
	sets the term structure to be used for pricing
FxSwapRateHelper inspectors
Real	spot () const
Period	tenor () const
Natural	fixingDays () const
Calendar	calendar () const
BusinessDayConvention	businessDayConvention () const
bool	endOfMonth () const
bool	isFxBaseCurrencyCollateralCurrency () const
Calendar	tradingCalendar () const
Calendar	adjustmentCalendar () const
Public Member Functions inherited from RelativeDateBootstrapHelper< YieldTermStructure >
	RelativeDateBootstrapHelper (const std::variant< Spread, Handle< Quote > > &quote, bool updateDates=true)
void	update () override
Public Member Functions inherited from BootstrapHelper< YieldTermStructure >
	BootstrapHelper (const std::variant< Spread, Handle< Quote > > &quote)
const Handle< Quote > &	quote () const
Real	quoteError () const
virtual Date	earliestDate () const
	earliest relevant date
virtual Date	maturityDate () const
	instrument's maturity date
virtual Date	latestRelevantDate () const
	latest relevant date
virtual Date	pillarDate () const
	pillar date
virtual Date	latestDate () const
	latest date
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 ()
Public Member Functions inherited from Observable
	Observable (const Observable &)
Observable &	operator= (const Observable &)
	Observable (Observable &&)=delete
Observable &	operator= (Observable &&)=delete
void	notifyObservers ()

Visitability
void	accept (AcyclicVisitor &) override

Additional Inherited Members
Public Types inherited from Observer
typedef set_type::iterator	iterator
Date	evaluationDate_
bool	updateDates_
Handle< Quote >	quote_
YieldTermStructure *	termStructure_
Date	earliestDate_
Date	latestDate_
Date	maturityDate_
Date	latestRelevantDate_
Date	pillarDate_

Detailed Description

Rate helper for bootstrapping over Fx Swap rates.

The forward is given by fwdFx = spotFx + fwdPoint.

isFxBaseCurrencyCollateralCurrency indicates if the base currency of the FX currency pair is the one used as collateral.

calendar is usually the joint calendar of the two currencies in the pair.

tradingCalendar can be used when the cross pairs don't include the currency of the business center (usually USD; the corresponding calendar is UnitedStates). If given, it will be used for adjusting the earliest settlement date and for setting the latest date. Due to FX spot market conventions, it is not sufficient to pass a JointCalendar with UnitedStates included as calendar; with regard the earliest date, this calendar is only used in case the spot date of the two currencies is not a US business day.

Warning

The ON fx swaps can be achieved by setting fixingDays to 0 and using a tenor of '1d'. The same tenor should be used for TN swaps, with fixingDays set to 1. However, handling ON and TN swaps for cross rates without USD is not trivial and should be treated with caution. If today is a US holiday, ON trade is not possible. If tomorrow is a US Holiday, the ON trade will be at least two business days long in the other countries and the TN trade will not exist. In such cases, if this helper is used for curve construction, probably it is safer not to pass a trading calendar to the ON and TN helpers and provide fwdPoints that will yield proper level of discount factors.

Member Function Documentation

impliedQuote()

Real impliedQuote ( ) const

overridevirtual

Implements BootstrapHelper< YieldTermStructure >.

setTermStructure()

void setTermStructure ( YieldTermStructure * )

overridevirtual

sets the term structure to be used for pricing

Warning

Being a pointer and not a shared_ptr, the term structure is not guaranteed to remain allocated for the whole life of the rate helper. It is responsibility of the programmer to ensure that the pointer remains valid. It is advised that this method is called only inside the term structure being bootstrapped, setting the pointer to this, i.e., the term structure itself.

Reimplemented from BootstrapHelper< YieldTermStructure >.

accept()

void accept ( AcyclicVisitor & )

overridevirtual

Reimplemented from BootstrapHelper< YieldTermStructure >.