Logo
Fully annotated reference manual - version 1.8.12
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
Dividend Struct Reference

#include <qle/indexes/dividendmanager.hpp>

+ Collaboration diagram for Dividend:

Public Member Functions

 Dividend ()
 Constructor. More...
 
 Dividend (const QuantLib::Date &ed, const std::string &s, const QuantLib::Real r, const QuantLib::Date &pd)
 
bool empty ()
 

Public Attributes

QuantLib::Date exDate = QuantLib::Date()
 Ex dividend date. More...
 
std::string name = std::string()
 Index name. More...
 
QuantLib::Real rate = QuantLib::Null<QuantLib::Real>()
 Dividend rate. More...
 
QuantLib::Date payDate = QuantLib::Date()
 Dividend Payment date. More...
 

Detailed Description

Definition at line 32 of file dividendmanager.hpp.

Constructor & Destructor Documentation

◆ Dividend() [1/2]

Dividend ( )

Constructor.

Definition at line 43 of file dividendmanager.hpp.

43{}

◆ Dividend() [2/2]

Dividend ( const QuantLib::Date &  ed,
const std::string &  s,
const QuantLib::Real  r,
const QuantLib::Date &  pd 
)

Definition at line 44 of file dividendmanager.hpp.

45 : exDate(ed), name(s), rate(r), payDate(pd) {}
QuantLib::Real rate
Dividend rate.
std::string name
Index name.
QuantLib::Date payDate
Dividend Payment date.
QuantLib::Date exDate
Ex dividend date.

Member Function Documentation

◆ empty()

bool empty ( )

Definition at line 46 of file dividendmanager.hpp.

46 {
47 return name.empty() && exDate == QuantLib::Date() && rate == QuantLib::Null<QuantLib::Real>() &&
48 payDate == QuantLib::Date();
49 }

Member Data Documentation

◆ exDate

QuantLib::Date exDate = QuantLib::Date()

Ex dividend date.

Definition at line 34 of file dividendmanager.hpp.

◆ name

std::string name = std::string()

Index name.

Definition at line 36 of file dividendmanager.hpp.

◆ rate

QuantLib::Real rate = QuantLib::Null<QuantLib::Real>()

Dividend rate.

Definition at line 38 of file dividendmanager.hpp.

◆ payDate

QuantLib::Date payDate = QuantLib::Date()

Dividend Payment date.

Definition at line 40 of file dividendmanager.hpp.