QuantLib_Event man page

Event — Base class for event.

Synopsis

#include <ql/event.hpp>

Inherits Observable.

Inherited by Callability, CashFlow, DefaultEvent, DefaultEvent::DefaultSettlement, and simple_event.

Public Member Functions

Event interface

virtual Date date () const =0
returns the date at which the event occurs
virtual bool hasOccurred (const Date &refDate=Date(), boost::optional< bool > includeRefDate=boost::none) const
returns true if an event has already occurred before a date

Visitability

virtual void accept (AcyclicVisitor &)

Detailed Description

Base class for event.

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

Member Function Documentation

virtual bool hasOccurred (const Date & refDate = Date(), boost::optional< bool > includeRefDate = boost::none) const [virtual]

returns true if an event has already occurred before a date If includeRefDate is true, then an event has not occurred if its date is the same as the refDate, i.e. this method returns false if the event date is the same as the refDate.

Reimplemented in CashFlow.

Author

Generated automatically by Doxygen for QuantLib from the source code.

Info

Fri Sep 23 2016 Version 1.8.1 QuantLib