bbldc::BasicDateRangeDayCountAdapter< CONVENTION > Class Template Reference

#include <bbldc_basicdaterangedaycountadapter.h>

Inheritance diagram for bbldc::BasicDateRangeDayCountAdapter< CONVENTION >:

Public Member Functions
int	daysDiff (const bdlt::Date &beginDate, const bdlt::Date &endDate) const BSLS_KEYWORD_OVERRIDE
const bdlt::Date &	firstDate () const BSLS_KEYWORD_OVERRIDE
const bdlt::Date &	lastDate () const BSLS_KEYWORD_OVERRIDE
double	yearsDiff (const bdlt::Date &beginDate, const bdlt::Date &endDate) const BSLS_KEYWORD_OVERRIDE
Public Member Functions inherited from bbldc::DateRangeDayCount
virtual	~DateRangeDayCount ()
	Destroy this object.

Detailed Description

template<class CONVENTION>
class bbldc::BasicDateRangeDayCountAdapter< CONVENTION >

This class provides an "adapter" from the specified CONVENTION to the bbldc::DateRangeDayCount protocol that can be used for determining values based on dates according to the day-count CONVENTION.

See bbldc_basicdaterangedaycountadapter

Member Function Documentation

daysDiff()

template<class CONVENTION >

int bbldc::BasicDateRangeDayCountAdapter< CONVENTION >::daysDiff ( const bdlt::Date &  beginDate, const bdlt::Date &  endDate  ) const

inlinevirtual

Return the (signed) number of days between the specified beginDate and endDate. If beginDate <= endDate, then the result is non-negative. The behavior is undefined unless firstDate() <= beginDate <= lastDate() and firstDate() <= endDate <= lastDate(). Note that reversing the order of beginDate and endDate negates the result.

Implements bbldc::DateRangeDayCount.

firstDate()

template<class CONVENTION >

const bdlt::Date & bbldc::BasicDateRangeDayCountAdapter< CONVENTION >::firstDate ( ) const

inlinevirtual

Return a reference providing non-modifiable access to a bdlt::Date with the value 1/1/1. Note that this value is the earliest date in the valid range of the adapted day-count convention.

Implements bbldc::DateRangeDayCount.

lastDate()

template<class CONVENTION >

const bdlt::Date & bbldc::BasicDateRangeDayCountAdapter< CONVENTION >::lastDate ( ) const

inlinevirtual

Return a reference providing non-modifiable access to a bdlt::Date with the value 9999/12/31. Note that this value is the latest date in the valid range of the adapted day-count convention.

Implements bbldc::DateRangeDayCount.

yearsDiff()

template<class CONVENTION >

double bbldc::BasicDateRangeDayCountAdapter< CONVENTION >::yearsDiff ( const bdlt::Date &  beginDate, const bdlt::Date &  endDate  ) const

inlinevirtual

Return the (signed fractional) number of years between the specified beginDate and endDate as per the CONVENTION template policy. If beginDate <= endDate, then the result is non-negative. Note that reversing the order of beginDate and endDate negates the result; specifically, |yearsDiff(b, e) + yearsDiff(e, b)| <= 1.0e-15 for all dates b and e.

Implements bbldc::DateRangeDayCount.

---

The documentation for this class was generated from the following file:

• bbldc_basicdaterangedaycountadapter.h