QuantLib_Event (3) - Linux Manuals

QuantLib_Event: Base class for event.

Command to display QuantLib_Event manual in Linux: $ man 3 QuantLib_Event

NAME

QuantLib::Event - Base class for event.

SYNOPSIS

#include <ql/event.hpp>

Inherits QuantLib::Observable.

Inherited by Callability, CashFlow, and DefaultEvent.

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 &)

Detailed Description

Base class for event.

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

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

Author

Generated automatically by Doxygen for QuantLib from the source code.