Event Class Reference

#include <ql/event.hpp>

Inheritance diagram for Event:

Inheritance graph
[legend]
List of all members.

Detailed Description

Base class for event.

This class acts as a base class for the actual event implementations.


Public Member Functions

Event interface
virtual Date date () const=0
 returns the date at which the event occurs
bool hasOccurred (const Date &d, bool includeToday=false) const
 returns true if an event has already occurred before a date
Visitability
virtual void accept (AcyclicVisitor &)


Member Function Documentation

bool hasOccurred ( const Date d,
bool  includeToday = false 
) const

returns true if an event has already occurred before a date

If QL_TODAYS_PAYMENT is true, then a payment event has not occurred if the input date is the same as the event date, and so includeToday should be defaulted to true.

This should be the only place in the code that is affected directly by QL_TODAYS_PAYMENT

Todo:
make QL_TODAYS_PAYMENT dynamically configurable?