Quick Links:

bal | bbl | bdl | bsl

Public Member Functions

bbldc::TerminatedDateRangeDayCountAdapter< CONVENTION > Class Template Reference

#include <bbldc_terminateddaterangedaycountadapter.h>

Inheritance diagram for bbldc::TerminatedDateRangeDayCountAdapter< CONVENTION >:
bbldc::DateRangeDayCount

List of all members.

Public Member Functions

 TerminatedDateRangeDayCountAdapter (const bdlt::Date &terminationDate)
virtual ~TerminatedDateRangeDayCountAdapter ()
int daysDiff (const bdlt::Date &beginDate, const bdlt::Date &endDate) const
const bdlt::DatefirstDate () const
const bdlt::DatelastDate () const
double yearsDiff (const bdlt::Date &beginDate, const bdlt::Date &endDate) const

Detailed Description

template<class CONVENTION>
class bbldc::TerminatedDateRangeDayCountAdapter< 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 Component bbldc_terminateddaterangedaycountadapter


Constructor & Destructor Documentation

template<class CONVENTION >
bbldc::TerminatedDateRangeDayCountAdapter< CONVENTION >::TerminatedDateRangeDayCountAdapter ( const bdlt::Date terminationDate  ) 

Create a day-count adapter that uses the specified terminationDate during.

template<class CONVENTION >
virtual bbldc::TerminatedDateRangeDayCountAdapter< CONVENTION >::~TerminatedDateRangeDayCountAdapter (  )  [virtual]

Destroy this object.


Member Function Documentation

template<class CONVENTION >
int bbldc::TerminatedDateRangeDayCountAdapter< CONVENTION >::daysDiff ( const bdlt::Date beginDate,
const bdlt::Date endDate 
) const [virtual]

Return the (signed) number of days 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.

Implements bbldc::DateRangeDayCount.

template<class CONVENTION >
const bdlt::Date& bbldc::TerminatedDateRangeDayCountAdapter< CONVENTION >::firstDate (  )  const [virtual]

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.

template<class CONVENTION >
const bdlt::Date& bbldc::TerminatedDateRangeDayCountAdapter< CONVENTION >::lastDate (  )  const [virtual]

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.

template<class CONVENTION >
double bbldc::TerminatedDateRangeDayCountAdapter< CONVENTION >::yearsDiff ( const bdlt::Date beginDate,
const bdlt::Date endDate 
) const [virtual]

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: