DayCounter Class Reference
[Date and time calculations]

#include <ql/daycounter.hpp>

Inheritance diagram for DayCounter:

Inheritance graph
[legend]
List of all members.

Detailed Description

day counter class

This class provides methods for determining the length of a time period according to given market convention, both as a number of days and as a year fraction.

The Bridge pattern is used to provide the base behavior of the day counter.


Public Member Functions

 DayCounter ()
DayCounter interface
std::string name () const
 Returns the name of the day counter.

BigInteger dayCount (const Date &, const Date &) const
 Returns the number of days between two dates.

Time yearFraction (const Date &, const Date &, const Date &refPeriodStart=Date(), const Date &refPeriodEnd=Date()) const
 Returns the period between two dates as a fraction of year.


Protected Member Functions

 DayCounter (const boost::shared_ptr< DayCounterImpl > &impl)

Related Functions

(Note that these are not member functions.)

bool operator== (const DayCounter &, const DayCounter &)
bool operator!= (const DayCounter &, const DayCounter &)


Constructor & Destructor Documentation

DayCounter  ) 
 

This default constructor returns a day counter with a null implementation, which is therefore unusable except as a placeholder.

DayCounter const boost::shared_ptr< DayCounterImpl > &  impl  )  [protected]
 

This protected constructor will only be invoked by derived classes which define a given DayCounter implementation


Member Function Documentation

std::string name  )  const
 

Returns the name of the day counter.

Warning:
This method is used for output and comparison between day counters. It is not meant to be used for writing switch-on-type code.


Friends And Related Function Documentation

bool operator== const DayCounter ,
const DayCounter
[related]
 

Returns true iff the two day counters belong to the same derived class.


QuantLib.org
QuantLib
Hosted by
SourceForge.net Logo
Documentation generated by
doxygen